Index
All Classes and Interfaces|All Packages|Serialized Form
A
- accept(String, Message) - Method in interface org.schlunzis.zis.stomp.client.OnErrorConsumer
-
Accepts an error that occurred during STOMP communication.
- add(ReceiptPolicy.Policy) - Method in class org.schlunzis.zis.stomp.client.ReceiptPolicy
-
Adds a policy to request receipts for the specified command.
- addFirst(String, String) - Method in interface org.schlunzis.zis.stomp.client.Headers
-
Adds a header with the specified key and value.
- all() - Static method in class org.schlunzis.zis.stomp.client.ReceiptPolicy
-
Creates a receipt policy that requests receipts for all supported commands.
- AuthenticationMethod - Enum Class in org.schlunzis.zis.stomp.client
-
Enumeration of supported authentication methods.
B
- body() - Method in interface org.schlunzis.zis.stomp.client.Message
-
Returns the body of the message.
- build() - Method in class org.schlunzis.zis.stomp.client.StompClientBuilder
-
Builds the
StompClientinstance. - builder() - Static method in interface org.schlunzis.zis.stomp.client.StompClient
-
Creates a new
StompClientBuilderfor building a STOMP client.
C
- close() - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Closes the STOMP client and releases all associated resources.
- connect() - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Connects to the STOMP server.
- connect(String, String) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Connects to the STOMP server using the provided login and passcode.
- connect(String, String, AuthenticationMethod) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Connects to the STOMP server using the provided login, passcode and authentication method.
- ConnectionException - Exception Class in org.schlunzis.zis.stomp.client
-
Exception thrown if an error occurs while connecting to the STOMP server.
- ConnectionException(String) - Constructor for exception class org.schlunzis.zis.stomp.client.ConnectionException
-
Constructs a new ConnectionException with the specified detail message.
- ConnectionException(String, Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.ConnectionException
-
Constructs a new ConnectionException with the specified detail message and cause.
- ConnectionException(Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.ConnectionException
-
Constructs a new ConnectionException with the specified cause.
- contentType() - Method in class org.schlunzis.zis.stomp.client.Jackson2MessageConverter
- contentType() - Method in class org.schlunzis.zis.stomp.client.Jackson3MessageConverter
- contentType() - Method in interface org.schlunzis.zis.stomp.client.MessageConverter
-
Returns the content type associated with this message converter.
- contentType() - Method in class org.schlunzis.zis.stomp.client.StringMessageConverter
- ConversionException - Exception Class in org.schlunzis.zis.stomp.client
-
Exception thrown for errors related to message conversion in STOMP client.
- ConversionException(String) - Constructor for exception class org.schlunzis.zis.stomp.client.ConversionException
-
Constructs a new ConversionException with the specified detail message.
- ConversionException(String, Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.ConversionException
-
Constructs a new ConversionException with the specified detail message and cause.
- ConversionException(Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.ConversionException
-
Constructs a new ConversionException with the specified cause.
- convertToString(Object) - Method in class org.schlunzis.zis.stomp.client.Jackson2MessageConverter
- convertToString(Object) - Method in class org.schlunzis.zis.stomp.client.Jackson3MessageConverter
- convertToString(Object) - Method in interface org.schlunzis.zis.stomp.client.MessageConverter
-
Converts the given object to its String representation.
- convertToString(Object) - Method in class org.schlunzis.zis.stomp.client.StringMessageConverter
- convertToType(String, Class) - Method in class org.schlunzis.zis.stomp.client.Jackson2MessageConverter
- convertToType(String, Class) - Method in class org.schlunzis.zis.stomp.client.Jackson3MessageConverter
- convertToType(String, Class) - Method in interface org.schlunzis.zis.stomp.client.MessageConverter
-
Converts the given message string to the specified target type.
- convertToType(String, Class) - Method in class org.schlunzis.zis.stomp.client.StringMessageConverter
D
- destination() - Method in interface org.schlunzis.zis.stomp.client.Subscription
-
The destination (topic) of the subscription.
- destinationPrefix() - Element in annotation interface org.schlunzis.zis.stomp.client.StompPublisher
-
The common destination prefix for all topics used by this publisher.
- destinationPrefix() - Element in annotation interface org.schlunzis.zis.stomp.client.StompSubscriber
-
The common destination prefix for all topics handled by this subscriber.
E
- endpoint(URI) - Method in class org.schlunzis.zis.stomp.client.StompClientBuilder
-
Sets the STOMP endpoint URI.
F
- FOR_DISCONNECT - Enum constant in enum class org.schlunzis.zis.stomp.client.ReceiptPolicy.Policy
-
Request receipt for DISCONNECT commands.
- FOR_SEND - Enum constant in enum class org.schlunzis.zis.stomp.client.ReceiptPolicy.Policy
-
Request receipt for SEND commands.
- FOR_SUBSCRIBE - Enum constant in enum class org.schlunzis.zis.stomp.client.ReceiptPolicy.Policy
-
Request receipt for SUBSCRIBE commands.
- FOR_UNSUBSCRIBE - Enum constant in enum class org.schlunzis.zis.stomp.client.ReceiptPolicy.Policy
-
Request receipt for UNSUBSCRIBE commands.
G
- getFirst(String) - Method in interface org.schlunzis.zis.stomp.client.Headers
-
Returns the first value associated with the specified key.
- getMessageConverter() - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Returns the message converter used by the STOMP client for converting message payloads.
H
- headers() - Method in interface org.schlunzis.zis.stomp.client.Message
-
Returns the headers of the message.
- Headers - Interface in org.schlunzis.zis.stomp.client
-
Represents the headers of a STOMP frame.
- HTTP_BASIC - Enum constant in enum class org.schlunzis.zis.stomp.client.AuthenticationMethod
-
HTTP Basic Authentication using the
Authorizationheader with Base64-encoded credentials.
I
- id() - Method in interface org.schlunzis.zis.stomp.client.Subscription
-
The unique identifier of the subscription.
- isEnabled(ReceiptPolicy.Policy) - Method in class org.schlunzis.zis.stomp.client.ReceiptPolicy
-
Checks if the receipt policy is enabled for the specified command.
J
- Jackson2MessageConverter - Class in org.schlunzis.zis.stomp.client
-
A MessageConverter implementation that uses Jackson 2 to convert messages between JSON string representation and target object types.
- Jackson2MessageConverter() - Constructor for class org.schlunzis.zis.stomp.client.Jackson2MessageConverter
-
Creates a new MessageConverter using a default Jackson 2 ObjectMapper.
- Jackson2MessageConverter(ObjectMapper) - Constructor for class org.schlunzis.zis.stomp.client.Jackson2MessageConverter
-
Creates a new MessageConverter using the provided Jackson 2 ObjectMapper.
- Jackson3MessageConverter - Class in org.schlunzis.zis.stomp.client
-
A MessageConverter implementation that uses Jackson 3 to convert messages between JSON string representation and target object types.
- Jackson3MessageConverter() - Constructor for class org.schlunzis.zis.stomp.client.Jackson3MessageConverter
-
Creates a new MessageConverter using a default Jackson 3 ObjectMapper.
- Jackson3MessageConverter(ObjectMapper) - Constructor for class org.schlunzis.zis.stomp.client.Jackson3MessageConverter
-
Creates a new MessageConverter using the provided Jackson 3 ObjectMapper.
M
- Message<T> - Interface in org.schlunzis.zis.stomp.client
-
Represents a STOMP message with headers and a body.
- messageConverter(MessageConverter) - Method in class org.schlunzis.zis.stomp.client.StompClientBuilder
-
Sets the message converter to be used by the client.
- MessageConverter - Interface in org.schlunzis.zis.stomp.client
-
Converts messages between String representation and target object types.
N
- none() - Static method in class org.schlunzis.zis.stomp.client.ReceiptPolicy
-
Creates a receipt policy that does not request any receipts.
O
- onError(OnErrorConsumer) - Method in class org.schlunzis.zis.stomp.client.StompClientBuilder
-
Sets the consumer to run when a STOMP ERROR frame is received.
- OnErrorConsumer - Interface in org.schlunzis.zis.stomp.client
-
Consumer for handling STOMP
ERRORframes. - org.schlunzis.stomp.annotation.processor - module org.schlunzis.stomp.annotation.processor
-
Module definition for the STOMP client annotation processor.
- org.schlunzis.zis.stomp.client - module org.schlunzis.zis.stomp.client
-
This module provides a STOMP client implementation using Jakarta WebSocket API.
- org.schlunzis.zis.stomp.client - package org.schlunzis.zis.stomp.client
-
This package contains the public API for the STOMP client.
P
- packageName() - Element in annotation interface org.schlunzis.zis.stomp.client.StompPublisher
-
The package name for the generated publisher class.
R
- receiptPolicy(ReceiptPolicy) - Method in class org.schlunzis.zis.stomp.client.StompClientBuilder
-
Sets the receipt policy for the client.
- ReceiptPolicy - Class in org.schlunzis.zis.stomp.client
-
Policy for requesting receipts from the STOMP server.
- ReceiptPolicy.Policy - Enum Class in org.schlunzis.zis.stomp.client
-
Policies for requesting receipts from the STOMP server.
- receiptTimeout(Duration) - Method in class org.schlunzis.zis.stomp.client.StompClientBuilder
-
Sets the receipt timeout duration.
- ReceiptTimeoutException - Exception Class in org.schlunzis.zis.stomp.client
-
Exception thrown when a receipt is not received within the configured timeout period.
- ReceiptTimeoutException(String) - Constructor for exception class org.schlunzis.zis.stomp.client.ReceiptTimeoutException
-
Constructs a new ReceiptTimeoutException with the specified detail message.
- ReceiptTimeoutException(String, Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.ReceiptTimeoutException
-
Constructs a new ReceiptTimeoutException with the specified detail message and cause.
- ReceiptTimeoutException(Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.ReceiptTimeoutException
-
Constructs a new ReceiptTimeoutException with the specified cause.
S
- send(String, Object) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Sends a message to the specified destination with the given body.
- send(String, String) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Sends a message to the specified destination with the given body.
- SendException - Exception Class in org.schlunzis.zis.stomp.client
-
Exception thrown for errors related to sending STOMP messages.
- SendException(String) - Constructor for exception class org.schlunzis.zis.stomp.client.SendException
-
Constructs a new SendException with the specified detail message.
- SendException(String, Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.SendException
-
Constructs a new SendException with the specified detail message and cause.
- SendException(Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.SendException
-
Constructs a new SendException with the specified cause.
- STOMP - Enum constant in enum class org.schlunzis.zis.stomp.client.AuthenticationMethod
-
Login and passcode authentication as defined in the STOMP protocol using the CONNECT frame.
- StompClient - Interface in org.schlunzis.zis.stomp.client
-
A STOMP client for sending and receiving messages over the STOMP protocol.
- StompClientBuilder - Class in org.schlunzis.zis.stomp.client
-
Builder for
StompClientinstances. - StompPublisher - Annotation Interface in org.schlunzis.zis.stomp.client
-
Annotation to mark a class as a STOMP publisher.
- StompSubscriber - Annotation Interface in org.schlunzis.zis.stomp.client
-
Annotation to mark a class as a STOMP subscriber.
- StringMessageConverter - Class in org.schlunzis.zis.stomp.client
-
A MessageConverter implementation that returns the message as-is for String types.
- StringMessageConverter() - Constructor for class org.schlunzis.zis.stomp.client.StringMessageConverter
-
Creates a new StringMessageConverter.
- subscribe(Object) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Subscribes all methods annotated with
Topicin the given subscriber object. - subscribe(String, Class, Consumer) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Subscribes to the specified destination to receive messages of the given payload type.
- Subscription - Interface in org.schlunzis.zis.stomp.client
-
Represents a STOMP subscription.
- SubscriptionException - Exception Class in org.schlunzis.zis.stomp.client
-
Exception thrown for errors related to STOMP subscriptions.
- SubscriptionException(String) - Constructor for exception class org.schlunzis.zis.stomp.client.SubscriptionException
-
Constructs a new SubscriptionException with the specified detail message.
- SubscriptionException(String, Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.SubscriptionException
-
Constructs a new SubscriptionException with the specified detail message and cause.
- SubscriptionException(Throwable) - Constructor for exception class org.schlunzis.zis.stomp.client.SubscriptionException
-
Constructs a new SubscriptionException with the specified cause.
T
- Topic - Annotation Interface in org.schlunzis.zis.stomp.client
-
Annotation to mark methods that handle messages from or to a specific STOMP topic.
- typeName() - Element in annotation interface org.schlunzis.zis.stomp.client.StompPublisher
-
The type name for the generated publisher class.
U
- unsubscribe(Object) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Unsubscribes all subscriptions created from the given subscriber object.
- unsubscribe(Subscription) - Method in interface org.schlunzis.zis.stomp.client.StompClient
-
Unsubscribes from the specified subscription.
V
- value() - Element in annotation interface org.schlunzis.zis.stomp.client.Topic
-
The STOMP topic to use for subscriptions or sending messages.
- valueOf(String) - Static method in enum class org.schlunzis.zis.stomp.client.AuthenticationMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.schlunzis.zis.stomp.client.ReceiptPolicy.Policy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.schlunzis.zis.stomp.client.AuthenticationMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.schlunzis.zis.stomp.client.ReceiptPolicy.Policy
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages|Serialized Form