See: Description
| Interface | Description |
|---|---|
| Acknowledgement |
Structure passed to acknowledgement handler called when a
ACK or NACK frame is received. |
| Destination |
Represents a STOMP destination.
|
| DestinationFactory |
Interface implemented to customize the destination creation.
|
| Frames |
Utility methods to build common
Frames. |
| ServerFrame |
Structure passed to server handler when receiving a frame.
|
| StompClient |
Defines a STOMP client.
|
| StompClientConnection |
Once a connection to the STOMP server has been made, client receives a
StompClientConnection, that let
send and receive STOMP frames. |
| StompOptions |
Defines a couples of constants shared by client and server options.
|
| StompServer |
Defines a STOMP server.
|
| StompServerConnection |
Class representing a connection between a STOMP client a the server.
|
| StompServerHandler |
STOMP server handler implements the behavior of the STOMP server when a specific event occurs.
|
| Class | Description |
|---|---|
| BridgeOptions |
Specify the event bus bridge options.
|
| DefaultAbortHandler |
STOMP compliant actions executed when receiving a
ABORT frame. |
| DefaultAckHandler |
STOMP compliant actions executed when receiving a
ACK frame. |
| DefaultBeginHandler |
STOMP compliant actions executed when receiving a
BEGIN frame. |
| DefaultCommitHandler |
STOMP compliant actions executed when receiving a
COMMIT frame. |
| DefaultConnectHandler |
STOMP compliant actions executed when receiving a
CONNECT frame. |
| DefaultNackHandler |
STOMP compliant actions executed when receiving a
NACK sf.frame(). |
| DefaultSendHandler |
STOMP compliant actions executed when receiving a
SEND sf.frame(). |
| DefaultSubscribeHandler |
STOMP compliant actions executed when receiving a
SUBSCRIBE frame. |
| DefaultUnsubscribeHandler |
STOMP compliant actions executed when receiving a
UNSUBSCRIBE frame. |
| Frame |
Represents a STOMP frame.
|
| Frame.Heartbeat |
Represents the heartbeat configuration.
|
| FrameConverter |
Converter for
Frame. |
| StompClientOptions |
Options used to configure a STOMP client.
|
| StompClientOptionsConverter |
Converter for
StompClientOptions. |
| StompServerOptions |
STOMP Server options.
|
| StompServerOptionsConverter |
Converter for
StompServerOptions. |
| Enum | Description |
|---|---|
| Frame.Command |
The list of command defined by the STOMP specification.
|
examples.StompServerExamples#example1
----
This creates a STOMP server listening on `localhost:61613` that is compliant with the STOMP specification.
You can configure the port and host in the StompServer.listen(int, java.lang.String)
method:
[source,$lang]
----
examples.StompServerExamples#example2
----
If you pass -1 as port, the TCP server would not be started. This is useful when using the websocket
bridge. To be notified when the server is ready, use a handler as follows:
[source,$lang]
----
examples.StompServerExamples#example3
----
The handler receive a reference on the StompServer.
You can also configure the host and port in StompServerOptions:
[source,$lang]
----
examples.StompServerExamples#example4
----
=== Closing a STOMP server
STOMP servers are closed as follows:
[source,$lang]
----
examples.StompServerExamples#example10
----
=== Configuration
The StompServerOptions let you configure some aspects of the STOMP server.
First, the STOMP server is based on a
NetServer, so you can configure the underlying NetServer from
the StompServerOptions. Alternatively you can also pass the
NetServer you want to use:
[source,$lang]
----
examples.StompServerExamples#example5
----
The StompServerOptions let you configure:
* the host and port of the STOMP server - defaults to `0.0.0.0:61613`.
* whether or not the STOMP server is secured - defaults to `false`
* the max STOMP frame body - default to 10 Mb
* the maximum number of headers accepted in a STOMP frame - defaults to 1000
* the max length of a header line in a STOMP frame - defaults to 10240
* the STOMP heartbeat time - default to `1000, 1000`
* the supported STOMP protocol versions (1.0, 1.1 and 1.2 by default)
* the maximum number of frame allowed in a transaction (defaults to 1000)
* the size of the transaction chunk - defaults to 1000 (see
StompServerOptions.setTransactionChunkSize(int))
* the maximum number of subscriptions a client can handle - defaults to 1000
The STOMP heartbeat is configured using a JSON object as follows:
[source,$lang]
----
examples.StompServerExamples#example6
----
Enabling security requires an additional AuthProvider handling the
authentication requests:
[source,$lang]
----
examples.StompServerExamples#example7
----
More information about AuthProvider is available
http://vertx.io/docs/#authentication_and_authorisation[here].
If a frame exceeds one of the size limits, the frame is rejected and the client receives an `ERROR` frame. As the
specification requires, the client connection is closed immediately after having sent the error. The same behavior
happens with the other thresholds.
=== Subscriptions
The default STOMP server handles subscription destination as opaque Strings. So it does not promote a structure
and it not hierarchic. By default the STOMP server follow a _topic_ semantic (so messages are dispatched to all
subscribers).
=== Type of destinations
By default, the STOMP server manages _destinations_ as topics. So messages are dispatched to all subscribers. You
can configure the server to use queues, or mix both types:
[source,$lang]
----
examples.StompServerExamples#example11
----
In the last example, all destination starting with `/queue` are queues while others are topics. The destination is
created when the first subscription on this destination is received.
A server can decide to reject the destination creation by returning `null`:
[source,$lang]
----
examples.StompServerExamples#example12
----
In this case, the subscriber received an `ERROR` frame.
Queues dispatches messages using a round-robin strategies.
=== Providing your own type of destination
On purpose the STOMP server does not implement any advanced feature. IF you need more advanced dispatching policy,
you can implement your own type of destination by providing a DestinationFactory
returning your own Destination object.
=== Acknowledgment
By default, the STOMP server does nothing when a message is not acknowledged. You can customize this by
providing your own Destination implementation.
The custom destination should call the
StompServerHandler.onAck(io.vertx.ext.stomp.StompServerConnection, io.vertx.ext.stomp.Frame, java.util.List)
and
StompServerHandler.onNack(io.vertx.ext.stomp.StompServerConnection, io.vertx.ext.stomp.Frame, java.util.List)
method in order to let the StompServerHandler customizes the behavior:
[source,$lang]
----
examples.StompServerExamples#example8
----
=== Customizing the STOMP server
In addition to the handlers seen above, you can configure almost all aspects of the STOMP server, such as the
actions made when specific frames are received, the `ping` to sent to the client (to implement the heartbeat).
Here are some examples:
[source,$lang]
----
examples.StompServerExamples#example9
----
Be aware that changing the default behavior may break the compliance with the STOMP specification. So, please look
at the default implementations.
== STOMP client
STOMP clients connect to STOMP server and can send and receive frames.
=== Creating a STOMP client
You create a StompClient instance with default options as follows:
[source,$lang]
----
examples.StompClientExamples#example1(io.vertx.core.Vertx)
----
The previous snippet creates a STOMP client connecting to "0.0.0.0:61613". Once connected, you get a
StompClientConnection that let you interact with the server. You can
configure the host and port as follows:
[source,$lang]
----
examples.StompClientExamples#example2(io.vertx.core.Vertx)
----
To catch connection errors due to authentication issues, or whatever error frames sent by the server during
the connection negotiation, you can register a _error handler_ on the Stomp Client. All
connections created with the client inherit of the error handler (but can have their own):
[source,$lang]
----
examples.StompClientExamples#example21(io.vertx.core.Vertx)
----
You can also configure the host and port in the StompClientOptions:
[source,$lang]
----
examples.StompClientExamples#example3(io.vertx.core.Vertx)
----
=== Closing a STOMP client
You can close a STOMP client:
[source,$lang]
----
examples.StompClientExamples#example4(io.vertx.core.Vertx)
----
However, this way would not notify the server of the disconnection. To cleanly close the connection, you should
use the StompClientConnection.disconnect() method:
[source,$lang]
----
examples.StompClientExamples#example5(io.vertx.core.Vertx)
----
If the heartbeat is enabled and if the client did not detect server activity after the configured timeout, the
connection is automatically closed.
=== Handling errors
On the StompClientConnection, you can register an error handler receiving `ERROR`
frames sent by the server. Notice that the server closes the connection with the client after having sent such frame:
[source,$lang]
----
examples.StompClientExamples#example6(io.vertx.core.Vertx)
----
The client can also be notified when a connection drop has been detected. Connection failures are detected using the
STOMP heartbeat mechanism. When the server has not sent a message in the heartbeat time window, the connection is
closed and the `connectionDroppedHandler` is called (if set). To configure a `connectionDroppedHandler`, call
StompClientConnection.connectionDroppedHandler(io.vertx.core.Handler). The handler can
for instance tries to reconnect to the server:
[source,$lang]
----
examples.StompClientExamples#example14(io.vertx.core.Vertx)
----
=== Configuration
You can configure various aspect by passing a
StompClientOptions when creating the StompClient. As the
STOMP client relies on a NetClient, you can configure the underlying Net Client from
the StompClientOptions. Alternatively, you can pass the NetClient
you want to use in the
StompClient.connect(io.vertx.core.net.NetClient, io.vertx.core.Handler) method:
[source,$lang]
----
examples.StompClientExamples#example7(io.vertx.core.Vertx, io.vertx.core.net.NetClient)
----
The StompClientOptions let you configure:
* the host and port ot the STOMP server
* the login and passcode to connect to the server
* whether or not the `content-length` header should be added to the frame if not set explicitly. (enabled by default)
* whether or not the `STOMP` command should be used instead of the `CONNECT` command (disabled by default)
* whether or not the `host` header should be ignored in the `CONNECT` frame (disabled by default)
* the heartbeat configuration (1000, 1000 by default)
=== Subscribing to destinations
To subscribe to a destination, use:
[source,$lang]
----
examples.StompClientExamples#example8(io.vertx.core.Vertx)
----
To unsubscribe, use:
[source,$lang]
----
examples.StompClientExamples#example9(io.vertx.core.Vertx)
----
=== Sending messages
To send a message, use:
[source,$lang]
----
examples.StompClientExamples#example10(io.vertx.core.Vertx)
----
[language,java,groovy]
----
In Java and Groovy, you can use the Headers class to ease the header creation.
----
=== Acknowledgements
Clients can send `ACK` and `NACK` frames:
[source,$lang]
----
examples.StompClientExamples#example11(io.vertx.core.Vertx)
----
=== Transactions
Clients can also create transactions. `ACK`, `NACK` and `SEND` frames sent in the transaction will be delivery
only when the transaction is committed.
[source,$lang]
----
examples.StompClientExamples#example12(io.vertx.core.Vertx)
----
=== Receipt
Each sent commands can have a _receipt_ handler, notified when the server has processed the message:
[source,$lang]
----
examples.StompClientExamples#example13(io.vertx.core.Vertx)
----
== Using the STOMP server as a bridge to the vert.x Event Bus
The STOMP server can be used as a bridge to the vert.x Event Bus. The bridge is bi-directional meaning the STOMP
frames are translated to Event Bus messages and Event Bus messages are translated to STOMP frames.
To enable the bridge you need to configure the inbound and outbound addresses. Inbound addresses are STOMP
destination that are transferred to the event bus. The STOMP destination is used as the event bus address. Outbound
addresses are event bus addresses that are transferred to STOMP.
[source,$lang]
----
examples.StompServerExamples#example13(io.vertx.core.Vertx)
----
By default, the bridge use a publish/subscribe delivery (topic). You can configure it to use a point to point
delivery where only one STOMP client or Event Bus consumer is invoked:
[source,$lang]
----
examples.StompServerExamples#example14(io.vertx.core.Vertx)
----
The permitted options can also be expressed as a "regex" or with a _match_. A _match_ is a structure that the
message payload must meet. For instance, in the next examples, the payload must contains the field "foo" set to
"bar". Structure match only supports JSON object.
[source,$lang]
----
examples.StompServerExamples#example15(io.vertx.core.Vertx)
----
== Using the STOMP server with web sockets
If you want to connect a JavaScript client (node.js or a browser) directly with the STOMP server, you can use a
web socket. The STOMP protocol has been adapted to work over web sockets in
http://jmesnil.net/stomp-websocket/doc/[StompJS]. The JavaScript connects directly to the STOMP server and send
STOMP frames on the web socket. It also receives the STOMP frame directly on the web socket.
To configure the server to use StompJS, you need to:
1. Enable the web socket bridge and configure the path of the listening web socket (/stomp by default).
2. Import http://jmesnil.net/stomp-websocket/doc/#download[StompJS] in your application (as a script on an
HTML page, or as an npm module (https://www.npmjs.com/package/stompjs).
3. Connect to the server
To achieve the first step, you would need a HTTP server, and pass the
StompServer.webSocketHandler() result to
HttpServer.websocketHandler(io.vertx.core.Handler):
[source,$lang]
----
examples.StompServerExamples#example16(io.vertx.core.Vertx)
----
Don't forget to declare the supported sub-protocols. Without this, the connection will be rejected.
Then follow the instructions from http://jmesnil.net/stomp-websocket/doc/[the StompJS documentation] to connect to
the server. Here is a simple example:
[source, javascript]
----
var url = "ws://localhost:8080/stomp";
var client = Stomp.client(url);
var callback = function(frame) {
console.log(frame);
};
client.connect({}, function() {
var subscription = client.subscribe("foo", callback);
});
----
== Registering received and writing frame handlers
STOMP clients, client's connections and server handlers support registering a received
Frame handler that would be notified every time a frame is received from the wire. It lets
you log the frames, or implement custom behavior. The handler is already called for PING
frames, and _illegal / unknown_ frames:
[source,$lang]
----
examples.StompServerExamples#example17(io.vertx.core.Vertx)
----
The handler is called before the frame is processed, so you can also _modify_ the frame.
Frames not using a valid STOMP command use the UNKNOWN command. The original command is written
in the headers using the Frame.STOMP_FRAME_COMMAND key.
You can also register a handler to be notified when a frame is going to be sent (written to the wire):
[source,$lang]
----
examples.StompServerExamples#example18(io.vertx.core.Vertx)
----Copyright © 2018 Eclipse. All rights reserved.