Package io.vertx.rxjava3.ext.stomp
Class StompServerHandler
- java.lang.Object
-
- io.vertx.rxjava3.ext.stomp.StompServerHandler
-
- All Implemented Interfaces:
Handler<ServerFrame>,io.vertx.lang.rx.RxDelegate
public class StompServerHandler extends Object implements io.vertx.lang.rx.RxDelegate, Handler<ServerFrame>
STOMP server handler implements the behavior of the STOMP server when a specific event occurs. For instance, if let customize the behavior when specific STOMP frames arrives or when a connection is closed. This class has been designed to let you customize the server behavior. The default implementation is compliant with the STOMP specification. In this default implementation, not acknowledge frames are dropped.NOTE: This class has been automatically generated from the
originalnon RX-ified interface using Vert.x codegen.
-
-
Field Summary
Fields Modifier and Type Field Description static io.vertx.lang.rx.TypeArg<StompServerHandler>__TYPE_ARG
-
Constructor Summary
Constructors Constructor Description StompServerHandler(StompServerHandler delegate)StompServerHandler(Object delegate)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StompServerHandlerabortHandler(Handler<ServerFrame> handler)Configures the action to execute when aABORTframe is received.StompServerHandlerackHandler(Handler<ServerFrame> handler)Configures the action to execute when aACKframe is received.StompServerHandlerauthProvider(AuthenticationProvider handler)Configures the to be used to authenticate the user.StompServerHandlerbeginHandler(Handler<ServerFrame> handler)Configures the action to execute when aBEGINframe is received.StompServerHandlerbridge(BridgeOptions options)Configures the STOMP server to act as a bridge with the Vert.x event bus.StompServerHandlercloseHandler(Handler<StompServerConnection> handler)Configures the action to execute when a connection with the client is closed.StompServerHandlercommitHandler(Handler<ServerFrame> handler)Configures the action to execute when aCOMMITframe is received.StompServerHandlerconnectHandler(Handler<ServerFrame> handler)Configures the action to execute when aCONNECTframe is received.static StompServerHandlercreate(Vertx vertx)Creates an instance ofStompServerHandlerusing the default (compliant) implementation.StompServerHandlerdestinationFactory(DestinationFactory factory)Configures theDestinationFactoryused to createDestinationobjects.StompServerHandlerdisconnectHandler(Handler<ServerFrame> handler)Configures the action to execute when aDISCONNECTframe is received.booleanequals(Object o)StompServerHandlergetDelegate()DestinationgetDestination(String destination)Gets the destination with the given name.List<Destination>getDestinations()DestinationgetOrCreateDestination(String destination)Gets aDestinationobject if existing, or create a new one.UsergetUserBySession(String session)Provides for authorization matches on a destination level, this will return the User created by the .voidhandle(ServerFrame event)Something has happened, so handle it.inthashCode()StompServerHandlernackHandler(Handler<ServerFrame> handler)Configures the action to execute when aNACKframe is received.static StompServerHandlernewInstance(StompServerHandler arg)StompServerHandleronAck(StompServerConnection connection, Frame subscribe, List<Frame> messages)Method called by single message (client-individual policy) or a set of message (client policy) are acknowledged.StompServerHandleronAckHandler(Handler<Acknowledgement> handler)Configures the action to execute when messages are acknowledged.Single<Boolean>onAuthenticationRequest(StompServerConnection connection, String login, String passcode)Called when the client connects to a server requiring authentication.voidonClose(StompServerConnection connection)Called when the connection is closed.StompServerHandleronNack(StompServerConnection connection, Frame subscribe, List<Frame> messages)Method called by single message (client-individual policy) or a set of message (client policy) are not acknowledged.StompServerHandleronNackHandler(Handler<Acknowledgement> handler)Configures the action to execute when messages are not acknowledged.StompServerHandlerpingHandler(Handler<StompServerConnection> handler)Allows customizing the action to do when the server needs to send a `PING` to the client.StompServerHandlerreceivedFrameHandler(Handler<ServerFrame> handler)Configures a handler that get notified when a STOMP frame is received by the server.Single<Boolean>rxOnAuthenticationRequest(StompServerConnection connection, String login, String passcode)Called when the client connects to a server requiring authentication.StompServerHandlersendHandler(Handler<ServerFrame> handler)Configures the action to execute when aSENDframe is received.StompServerHandlerstompHandler(Handler<ServerFrame> handler)Configures the action to execute when aSTOMPframe is received.StompServerHandlersubscribeHandler(Handler<ServerFrame> handler)Configures the action to execute when aSUBSCRIBEframe is received.StringtoString()StompServerHandlerunsubscribeHandler(Handler<ServerFrame> handler)Configures the action to execute when aUNSUBSCRIBEframe is received.
-
-
-
Field Detail
-
__TYPE_ARG
public static final io.vertx.lang.rx.TypeArg<StompServerHandler> __TYPE_ARG
-
-
Constructor Detail
-
StompServerHandler
public StompServerHandler(StompServerHandler delegate)
-
StompServerHandler
public StompServerHandler(Object delegate)
-
-
Method Detail
-
getDelegate
public StompServerHandler getDelegate()
- Specified by:
getDelegatein interfaceio.vertx.lang.rx.RxDelegate
-
handle
public void handle(ServerFrame event)
Something has happened, so handle it.- Specified by:
handlein interfaceHandler<ServerFrame>- Parameters:
event- the event to handle
-
create
public static StompServerHandler create(Vertx vertx)
Creates an instance ofStompServerHandlerusing the default (compliant) implementation.- Parameters:
vertx- the vert.x instance to use- Returns:
- the created
StompServerHandler
-
receivedFrameHandler
public StompServerHandler receivedFrameHandler(Handler<ServerFrame> handler)
Configures a handler that get notified when a STOMP frame is received by the server. This handler can be used for logging, debugging or ad-hoc behavior.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
connectHandler
public StompServerHandler connectHandler(Handler<ServerFrame> handler)
Configures the action to execute when aCONNECTframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
stompHandler
public StompServerHandler stompHandler(Handler<ServerFrame> handler)
Configures the action to execute when aSTOMPframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
subscribeHandler
public StompServerHandler subscribeHandler(Handler<ServerFrame> handler)
Configures the action to execute when aSUBSCRIBEframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
unsubscribeHandler
public StompServerHandler unsubscribeHandler(Handler<ServerFrame> handler)
Configures the action to execute when aUNSUBSCRIBEframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
sendHandler
public StompServerHandler sendHandler(Handler<ServerFrame> handler)
Configures the action to execute when aSENDframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
closeHandler
public StompServerHandler closeHandler(Handler<StompServerConnection> handler)
Configures the action to execute when a connection with the client is closed.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
onClose
public void onClose(StompServerConnection connection)
Called when the connection is closed. This method executes a default behavior and must calls the configuredcloseHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.stomp.StompServerConnection>)if any.- Parameters:
connection- the connection
-
commitHandler
public StompServerHandler commitHandler(Handler<ServerFrame> handler)
Configures the action to execute when aCOMMITframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
abortHandler
public StompServerHandler abortHandler(Handler<ServerFrame> handler)
Configures the action to execute when aABORTframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
beginHandler
public StompServerHandler beginHandler(Handler<ServerFrame> handler)
Configures the action to execute when aBEGINframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
disconnectHandler
public StompServerHandler disconnectHandler(Handler<ServerFrame> handler)
Configures the action to execute when aDISCONNECTframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
ackHandler
public StompServerHandler ackHandler(Handler<ServerFrame> handler)
Configures the action to execute when aACKframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
nackHandler
public StompServerHandler nackHandler(Handler<ServerFrame> handler)
Configures the action to execute when aNACKframe is received.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
onAuthenticationRequest
public Single<Boolean> onAuthenticationRequest(StompServerConnection connection, String login, String passcode)
Called when the client connects to a server requiring authentication. It invokes the configured usingauthProvider(io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider).- Parameters:
connection- server connection that contains session IDlogin- the loginpasscode- the password- Returns:
- a future notified with the authentication result
-
rxOnAuthenticationRequest
public Single<Boolean> rxOnAuthenticationRequest(StompServerConnection connection, String login, String passcode)
Called when the client connects to a server requiring authentication. It invokes the configured usingauthProvider(io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider).- Parameters:
connection- server connection that contains session IDlogin- the loginpasscode- the password- Returns:
- a future notified with the authentication result
-
getUserBySession
public User getUserBySession(String session)
Provides for authorization matches on a destination level, this will return the User created by the .- Parameters:
session- session ID for the server connection.- Returns:
- null if not authenticated.
-
authProvider
public StompServerHandler authProvider(AuthenticationProvider handler)
Configures the to be used to authenticate the user.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
getDestinations
public List<Destination> getDestinations()
- Returns:
- the list of destination managed by the STOMP server. Don't forget the STOMP interprets destination as opaque Strings.
-
getDestination
public Destination getDestination(String destination)
Gets the destination with the given name.- Parameters:
destination- the destination- Returns:
- the
Destination,nullif not existing.
-
onAck
public StompServerHandler onAck(StompServerConnection connection, Frame subscribe, List<Frame> messages)
Method called by single message (client-individual policy) or a set of message (client policy) are acknowledged. Implementations must call the handler configured usingonAckHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.stomp.Acknowledgement>).- Parameters:
connection- the connectionsubscribe- theSUBSCRIBEframemessages- the acknowledge messages- Returns:
- the current
StompServerHandler
-
onNack
public StompServerHandler onNack(StompServerConnection connection, Frame subscribe, List<Frame> messages)
Method called by single message (client-individual policy) or a set of message (client policy) are not acknowledged. Not acknowledgment can result from aNACKframe or from a timeout (noACKframe received in a given time. Implementations must call the handler configured usingonNackHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.stomp.Acknowledgement>).- Parameters:
connection- the connectionsubscribe- theSUBSCRIBEframemessages- the acknowledge messages- Returns:
- the current
StompServerHandler
-
onAckHandler
public StompServerHandler onAckHandler(Handler<Acknowledgement> handler)
Configures the action to execute when messages are acknowledged.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
onNackHandler
public StompServerHandler onNackHandler(Handler<Acknowledgement> handler)
Configures the action to execute when messages are not acknowledged.- Parameters:
handler- the handler- Returns:
- the current
StompServerHandler
-
pingHandler
public StompServerHandler pingHandler(Handler<StompServerConnection> handler)
Allows customizing the action to do when the server needs to send a `PING` to the client. By default it send a frame containingEOL(specification). However, you can customize this and send another frame. However, be aware that this may requires a custom client. The handler will only be called if the connection supports heartbeats.- Parameters:
handler- the action to execute when a `PING` needs to be sent.- Returns:
- the current
StompServerHandler
-
getOrCreateDestination
public Destination getOrCreateDestination(String destination)
Gets aDestinationobject if existing, or create a new one. The creation is delegated to theDestinationFactory.- Parameters:
destination- the destination- Returns:
- the
Destinationinstance, may have been created.
-
destinationFactory
public StompServerHandler destinationFactory(DestinationFactory factory)
Configures theDestinationFactoryused to createDestinationobjects.- Parameters:
factory- the factory- Returns:
- the current
StompServerHandler.
-
bridge
public StompServerHandler bridge(BridgeOptions options)
Configures the STOMP server to act as a bridge with the Vert.x event bus.- Parameters:
options- the configuration options- Returns:
- the current
StompServerHandler.
-
newInstance
public static StompServerHandler newInstance(StompServerHandler arg)
-
-