public class StompServerHandler extends Object implements Handler<ServerFrame>
original non RX-ified interface using Vert.x codegen.| Modifier and Type | Field and Description |
|---|---|
static io.vertx.lang.rx.TypeArg<StompServerHandler> |
__TYPE_ARG |
| Constructor and Description |
|---|
StompServerHandler(Object delegate) |
StompServerHandler(StompServerHandler delegate) |
| 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 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. |
boolean |
equals(Object o) |
StompServerHandler |
getDelegate() |
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 .
|
void |
handle(ServerFrame event)
Something has happened, so handle it.
|
int |
hashCode() |
StompServerHandler |
nackHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
NACK frame is received. |
static StompServerHandler |
newInstance(StompServerHandler arg) |
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.
|
Single<Boolean> |
onAuthenticationRequest(StompServerConnection connection,
String login,
String passcode)
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.
|
Single<Boolean> |
rxOnAuthenticationRequest(StompServerConnection connection,
String login,
String passcode)
Called when the client connects to a server requiring authentication.
|
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. |
String |
toString() |
StompServerHandler |
unsubscribeHandler(Handler<ServerFrame> handler)
Configures the action to execute when a
UNSUBSCRIBE frame is received. |
public static final io.vertx.lang.rx.TypeArg<StompServerHandler> __TYPE_ARG
public StompServerHandler(StompServerHandler delegate)
public StompServerHandler(Object delegate)
public StompServerHandler getDelegate()
public void handle(ServerFrame event)
handle in interface Handler<ServerFrame>event - the event to handlepublic static StompServerHandler create(Vertx vertx)
StompServerHandler using the default (compliant) implementation.vertx - the vert.x instance to useStompServerHandlerpublic StompServerHandler receivedFrameHandler(Handler<ServerFrame> handler)
handler - the handlerStompServerHandlerpublic StompServerHandler connectHandler(Handler<ServerFrame> handler)
CONNECT frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler stompHandler(Handler<ServerFrame> handler)
STOMP frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler subscribeHandler(Handler<ServerFrame> handler)
SUBSCRIBE frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler unsubscribeHandler(Handler<ServerFrame> handler)
UNSUBSCRIBE frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler sendHandler(Handler<ServerFrame> handler)
SEND frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler closeHandler(Handler<StompServerConnection> handler)
handler - the handlerStompServerHandlerpublic void onClose(StompServerConnection connection)
closeHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.stomp.StompServerConnection>) if any.connection - the connectionpublic StompServerHandler commitHandler(Handler<ServerFrame> handler)
COMMIT frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler abortHandler(Handler<ServerFrame> handler)
ABORT frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler beginHandler(Handler<ServerFrame> handler)
BEGIN frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler disconnectHandler(Handler<ServerFrame> handler)
DISCONNECT frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler ackHandler(Handler<ServerFrame> handler)
ACK frame is received.handler - the handlerStompServerHandlerpublic StompServerHandler nackHandler(Handler<ServerFrame> handler)
NACK frame is received.handler - the handlerStompServerHandlerpublic Single<Boolean> onAuthenticationRequest(StompServerConnection connection, String login, String passcode)
authProvider(io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider).connection - server connection that contains session IDlogin - the loginpasscode - the passwordStompServerHandlerpublic Single<Boolean> rxOnAuthenticationRequest(StompServerConnection connection, String login, String passcode)
authProvider(io.vertx.rxjava3.ext.auth.authentication.AuthenticationProvider).connection - server connection that contains session IDlogin - the loginpasscode - the passwordStompServerHandlerpublic User getUserBySession(String session)
session - session ID for the server connection.public StompServerHandler authProvider(AuthenticationProvider handler)
handler - the handlerStompServerHandlerpublic List<Destination> getDestinations()
public Destination getDestination(String destination)
destination - the destinationDestination, null if not existing.public StompServerHandler onAck(StompServerConnection connection, Frame subscribe, List<Frame> messages)
onAckHandler(io.vertx.core.Handler<io.vertx.rxjava3.ext.stomp.Acknowledgement>).connection - the connectionsubscribe - the SUBSCRIBE framemessages - the acknowledge messagesStompServerHandlerpublic 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(io.vertx.core.Handler<io.vertx.rxjava3.ext.stomp.Acknowledgement>).connection - the connectionsubscribe - the SUBSCRIBE framemessages - the acknowledge messagesStompServerHandlerpublic StompServerHandler onAckHandler(Handler<Acknowledgement> handler)
handler - the handlerStompServerHandlerpublic StompServerHandler onNackHandler(Handler<Acknowledgement> handler)
handler - the handlerStompServerHandlerpublic 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.StompServerHandlerpublic 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.public StompServerHandler destinationFactory(DestinationFactory factory)
DestinationFactory used to create Destination objects.factory - the factoryStompServerHandler.public StompServerHandler bridge(BridgeOptions options)
options - the configuration optionsStompServerHandler.public static StompServerHandler newInstance(StompServerHandler arg)
Copyright © 2023 Eclipse. All rights reserved.