org.springframework.messaging.simp.stomp.StompSessionHandler Maven / Gradle / Ivy
/*
* Copyright 2002-2017 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.messaging.simp.stomp;
import org.springframework.lang.Nullable;
/**
* A contract for client STOMP session lifecycle events including a callback
* when the session is established and notifications of transport or message
* handling failures.
*
* This contract also extends {@link StompFrameHandler} in order to handle
* STOMP ERROR frames received from the broker.
*
*
Implementations of this interface should consider extending
* {@link StompSessionHandlerAdapter}.
*
* @author Rossen Stoyanchev
* @since 4.2
* @see StompSessionHandlerAdapter
*/
public interface StompSessionHandler extends StompFrameHandler {
/**
* Invoked when the session is ready to use, i.e. after the underlying
* transport (TCP, WebSocket) is connected and a STOMP CONNECTED frame is
* received from the broker.
* @param session the client STOMP session
* @param connectedHeaders the STOMP CONNECTED frame headers
*/
void afterConnected(StompSession session, StompHeaders connectedHeaders);
/**
* Handle any exception arising while processing a STOMP frame such as a
* failure to convert the payload or an unhandled exception in the
* application {@code StompFrameHandler}.
* @param session the client STOMP session
* @param command the STOMP command of the frame
* @param headers the headers
* @param payload the raw payload
* @param exception the exception
*/
void handleException(StompSession session, @Nullable StompCommand command,
StompHeaders headers, byte[] payload, Throwable exception);
/**
* Handle a low level transport error which could be an I/O error or a
* failure to encode or decode a STOMP message.
*
Note that
* {@link org.springframework.messaging.simp.stomp.ConnectionLostException
* ConnectionLostException} will be passed into this method when the
* connection is lost rather than closed normally via
* {@link StompSession#disconnect()}.
* @param session the client STOMP session
* @param exception the exception that occurred
*/
void handleTransportError(StompSession session, Throwable exception);
}