public interface StompServerHandler extends Handler<ServerFrame>
Modifier and Type | Method and Description |
---|---|
StompServerHandler |
abortHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
ABORT frame is received. |
StompServerHandler |
ackHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
ACK frame is received. |
StompServerHandler |
authProvider(AuthenticationProvider handler)
Configures the
AuthenticationProvider to be used to authenticate the user. |
StompServerHandler |
beginHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
BEGIN frame is received. |
StompServerHandler |
bridge(BridgeOptions options)
Configures the STOMP server to act as a bridge with the Vert.x event bus.
|
StompServerHandler |
closeHandler(Handler<StompServerConnection> handler)
Configures the action to execute when a connection with the client is closed.
|
StompServerHandler |
commitHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
COMMIT frame is received. |
StompServerHandler |
connectHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
CONNECT frame is received. |
static StompServerHandler |
create(Vertx vertx)
Creates an instance of
StompServerHandler using the default (compliant) implementation. |
StompServerHandler |
destinationFactory(DestinationFactory factory)
Configures the
DestinationFactory used to create Destination objects. |
StompServerHandler |
disconnectHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
DISCONNECT frame is received. |
Destination |
getDestination(String destination)
Gets the destination with the given name.
|
List<Destination> |
getDestinations() |
Destination |
getOrCreateDestination(String destination)
Gets a
Destination object if existing, or create a new one. |
User |
getUserBySession(String session)
Provides for authorization matches on a destination level, this will return the User created by the
AuthenticationProvider . |
StompServerHandler |
nackHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
NACK frame is received. |
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.
|
StompServerHandler |
onAckHandler(Handler<Acknowledgement> handler)
Configures the action to execute when messages are acknowledged.
|
Future<Boolean> |
onAuthenticationRequest(StompServerConnection connection,
String login,
String passcode)
Like
onAuthenticationRequest(StompServerConnection, String, String, Handler) but with a future of the result |
StompServerHandler |
onAuthenticationRequest(StompServerConnection connection,
String login,
String passcode,
Handler<AsyncResult<Boolean>> handler)
Called when the client connects to a server requiring authentication.
|
void |
onClose(StompServerConnection connection)
Called when the connection is closed.
|
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.
|
StompServerHandler |
onNackHandler(Handler<Acknowledgement> handler)
Configures the action to execute when messages are not acknowledged.
|
StompServerHandler |
pingHandler(Handler<StompServerConnection> handler)
Allows customizing the action to do when the server needs to send a `PING` to the client.
|
StompServerHandler |
receivedFrameHandler(Handler<ServerFrame> handler)
Configures a handler that get notified when a STOMP frame is received by the server.
|
StompServerHandler |
sendHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
SEND frame is received. |
StompServerHandler |
stompHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
STOMP frame is received. |
StompServerHandler |
subscribeHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
SUBSCRIBE frame is received. |
StompServerHandler |
unsubscribeHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
UNSUBSCRIBE frame is received. |
static StompServerHandler create(Vertx vertx)
StompServerHandler
using the default (compliant) implementation.vertx
- the vert.x instance to useStompServerHandler
StompServerHandler receivedFrameHandler(Handler<ServerFrame> handler)
handler
- the handlerStompServerHandler
StompServerHandler connectHandler(Handler<ServerFrame> handler)
CONNECT
frame is received.handler
- the handlerStompServerHandler
StompServerHandler stompHandler(Handler<ServerFrame> handler)
STOMP
frame is received.handler
- the handlerStompServerHandler
StompServerHandler subscribeHandler(Handler<ServerFrame> handler)
SUBSCRIBE
frame is received.handler
- the handlerStompServerHandler
StompServerHandler unsubscribeHandler(Handler<ServerFrame> handler)
UNSUBSCRIBE
frame is received.handler
- the handlerStompServerHandler
StompServerHandler sendHandler(Handler<ServerFrame> handler)
SEND
frame is received.handler
- the handlerStompServerHandler
StompServerHandler closeHandler(Handler<StompServerConnection> handler)
handler
- the handlerStompServerHandler
void onClose(StompServerConnection connection)
closeHandler(Handler)
if any.connection
- the connectionStompServerHandler commitHandler(Handler<ServerFrame> handler)
COMMIT
frame is received.handler
- the handlerStompServerHandler
StompServerHandler abortHandler(Handler<ServerFrame> handler)
ABORT
frame is received.handler
- the handlerStompServerHandler
StompServerHandler beginHandler(Handler<ServerFrame> handler)
BEGIN
frame is received.handler
- the handlerStompServerHandler
StompServerHandler disconnectHandler(Handler<ServerFrame> handler)
DISCONNECT
frame is received.handler
- the handlerStompServerHandler
StompServerHandler ackHandler(Handler<ServerFrame> handler)
ACK
frame is received.handler
- the handlerStompServerHandler
StompServerHandler nackHandler(Handler<ServerFrame> handler)
NACK
frame is received.handler
- the handlerStompServerHandler
StompServerHandler onAuthenticationRequest(StompServerConnection connection, String login, String passcode, Handler<AsyncResult<Boolean>> handler)
AuthenticationProvider
configured
using authProvider(AuthenticationProvider)
.connection
- server connection that contains session IDlogin
- the loginpasscode
- the passwordhandler
- handler receiving the authentication resultStompServerHandler
Future<Boolean> onAuthenticationRequest(StompServerConnection connection, String login, String passcode)
onAuthenticationRequest(StompServerConnection, String, String, Handler)
but with a future of the resultUser getUserBySession(String session)
AuthenticationProvider
.session
- session ID for the server connection.StompServerHandler authProvider(AuthenticationProvider handler)
AuthenticationProvider
to be used to authenticate the user.handler
- the handlerStompServerHandler
List<Destination> getDestinations()
Destination getDestination(String destination)
destination
- the destinationDestination
, null
if not existing.StompServerHandler onAck(StompServerConnection connection, Frame subscribe, List<Frame> messages)
onAckHandler(Handler)
.connection
- the connectionsubscribe
- the SUBSCRIBE
framemessages
- the acknowledge messagesStompServerHandler
StompServerHandler onNack(StompServerConnection connection, Frame subscribe, List<Frame> messages)
NACK
frame or from a timeout (no
ACK
frame received in a given time. Implementations must call the handler configured using
onNackHandler(Handler)
.connection
- the connectionsubscribe
- the SUBSCRIBE
framemessages
- the acknowledge messagesStompServerHandler
StompServerHandler onAckHandler(Handler<Acknowledgement> handler)
handler
- the handlerStompServerHandler
onAck(StompServerConnection, Frame, List)
StompServerHandler onNackHandler(Handler<Acknowledgement> handler)
handler
- the handlerStompServerHandler
onNack(StompServerConnection, Frame, List)
StompServerHandler pingHandler(Handler<StompServerConnection> handler)
EOL
(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.handler
- the action to execute when a `PING` needs to be sent.StompServerHandler
Destination getOrCreateDestination(String destination)
Destination
object if existing, or create a new one. The creation is delegated to the
DestinationFactory
.destination
- the destinationDestination
instance, may have been created.StompServerHandler destinationFactory(DestinationFactory factory)
DestinationFactory
used to create Destination
objects.factory
- the factoryStompServerHandler
.StompServerHandler bridge(BridgeOptions options)
options
- the configuration optionsStompServerHandler
.Vertx.eventBus()
Copyright © 2021 Eclipse. All rights reserved.