public interface JMSClient
| Modifier and Type | Method and Description |
|---|---|
void |
clearMessages()
Clear all read messages from client's storage.
|
void |
closeConnection()
Permanently closes JMS client connection.
|
String |
createTemporaryQueue()
Create new temporary queue.
|
String |
createTemporaryTopic()
Create new temporary topic.
|
void |
deleteTemporaryQueue(String queueName)
Deletes temporary queue.
|
void |
deleteTemporaryTopic(String topicName)
Deletes temporary topic.
|
String |
getClientID() |
byte[] |
getMessageByteContent(String messageID)
Return byte message's byte content.
|
String |
getMessageCorrelationID(String messageID)
Return message's correlation ID
|
String |
getMessageDestinationName(String messageID)
Return message's target destination (Queue or Topic) name.
|
long |
getMessageExpirationTime(String messageID)
Return message's expiration time in milliseconds.
|
String |
getMessageID(String messageID)
Return message's unique ID.
|
Map<String,Object> |
getMessageMapContent(String messageID)
Return map message's map content.
|
int |
getMessagePriority(String messageID)
Return message's priority value from 1-9.
|
Object |
getMessageProperty(String propertyName,
String messageID)
Return message property value
|
String |
getMessageReplyToQueue(String messageID)
Return message's reply to queue (or topic) target destination.
|
String |
getMessageTextContent(String messageID)
Return text message's string content.
|
long |
getMessageTimestamp(String messageID)
Return message's latest timestamp.
|
String |
getMessageType(String messageID)
Return message's JMS type.
|
int |
getQueueDepth(String queueName)
Return specified queue current depth (Amount of unread messages in queue).
|
void |
initializeClient(Map<String,Object> parameters)
Initializes current JMS client wrapper.
|
void |
openConnection()
Open new connection into MQ provider/broker.
|
void |
openConnection(String userName,
String password)
Open new connection into MQ provider/broker.
|
String |
peekFromQueue(String queueName,
String messageSelector)
Peek first message from the queue.
|
void |
publishIntoTopic(String topicName,
byte[] content,
Map<String,Object> parameters,
Map<String,Object> properties)
Publish new message into topic.
|
void |
publishIntoTopic(String topicName,
Map<String,Object> content,
Map<String,Object> parameters,
Map<String,Object> properties)
Publish new message into topic.
|
void |
publishIntoTopic(String topicName,
String content,
Map<String,Object> parameters,
Map<String,Object> properties)
Publish new message into topic.
|
void |
purgeQueue(String queueName)
Remove all messages from specified queue.
|
String |
readFromQueue(String queueName,
long timeout,
String messageSelector)
Read single message from the queue.
|
String |
readFromTopic(String name,
long timeout)
Read single message from the topic.
|
MessageTypeEnum |
resolveMessageType(String messageID)
Resolve JMS message's type.
|
void |
subscribeTopic(String topicName,
String name,
String messageSelector)
Make new durable subscription into topic.
|
void |
unsubscribeTopic(String name)
Cancel made durable subscription for the topic.
|
void |
writeIntoQueue(String queueName,
byte[] content,
Map<String,Object> parameters,
Map<String,Object> properties)
Write new message into queue
|
void |
writeIntoQueue(String queueName,
Map<String,Object> content,
Map<String,Object> parameters,
Map<String,Object> properties)
Write new message into queue
|
void |
writeIntoQueue(String queueName,
String content,
Map<String,Object> parameters,
Map<String,Object> properties)
Write new message into queue
|
void clearMessages()
void closeConnection()
throws javax.jms.JMSException
javax.jms.JMSException - If closing of connection failsString createTemporaryQueue() throws javax.jms.JMSException
javax.jms.JMSException - If temporary queue creation fails.String createTemporaryTopic() throws javax.jms.JMSException
javax.jms.JMSException - If temporary topic creation fails.void deleteTemporaryQueue(String queueName) throws javax.jms.JMSException
queueName - - Temporary queue namejavax.jms.JMSException - If deletion fails.void deleteTemporaryTopic(String topicName) throws javax.jms.JMSException
topicName - - Temporary topic namejavax.jms.JMSException - If deletion fails.String getClientID()
byte[] getMessageByteContent(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If reading bytes from message fails.Map<String,Object> getMessageMapContent(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If reading map from message fails.String getMessageCorrelationID(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.String getMessageDestinationName(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.long getMessageExpirationTime(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.String getMessageID(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.int getMessagePriority(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.Object getMessageProperty(String propertyName, String messageID) throws javax.jms.JMSException
propertyName - - Name of the propertymessageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.String getMessageReplyToQueue(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.String getMessageTextContent(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - - If getting message content fails for any reason.long getMessageTimestamp(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.String getMessageType(String messageID) throws javax.jms.JMSException
messageID - - Optional message ID. If not given then method attempt to read content from latest read messagejavax.jms.JMSException - If getting message's meta data fails.int getQueueDepth(String queueName) throws javax.jms.JMSException
queueName - - Name of the queue to checkjavax.jms.JMSException - If getting queue depth fails for any reason.void initializeClient(Map<String,Object> parameters) throws Exception
parameters - - Parameters for client initialization.Exception - If initializing the client fails for any reason.void openConnection()
throws javax.jms.JMSException
javax.jms.JMSException - If opening the connection fails.void openConnection(String userName, String password) throws javax.jms.JMSException
userName - - User name used for connection authenticationpassword - - Password used for connection authenticationjavax.jms.JMSException - If opening the connection fails.String peekFromQueue(String queueName, String messageSelector) throws javax.jms.JMSException
queueName - - Queue to peek frommessageSelector - - Optional message selector to filter queue contentnull if no message was peeked from the queue.javax.jms.JMSException - If reading the message fails.void publishIntoTopic(String topicName, String content, Map<String,Object> parameters, Map<String,Object> properties) throws javax.jms.JMSException
topicName - - Topic name into which message is publishedcontent - - Message's contentparameters - - Optional message's JMS parameters.
Key values are defined in MessageParameterNamesproperties - - Optional JMS message propertiesjavax.jms.JMSException - If message creation or publish it into topic fails.MessageParameterNamesvoid publishIntoTopic(String topicName, byte[] content, Map<String,Object> parameters, Map<String,Object> properties) throws javax.jms.JMSException
topicName - - Topic name into which message is publishedcontent - - Message's contentparameters - - Optional message's JMS parameters.
Key values are defined in MessageParameterNamesproperties - - Optional JMS message propertiesjavax.jms.JMSException - If message creation or publish it into topic fails.MessageParameterNamesvoid publishIntoTopic(String topicName, Map<String,Object> content, Map<String,Object> parameters, Map<String,Object> properties) throws javax.jms.JMSException
topicName - - Topic name into which message is publishedcontent - - Message's contentparameters - - Optional message's JMS parameters.
Key values are defined in MessageParameterNamesproperties - - Optional JMS message propertiesjavax.jms.JMSException - If message creation or publish it into topic fails.MessageParameterNamesvoid purgeQueue(String queueName) throws javax.jms.JMSException
queueName - - Name of the queue to purge from messagesjavax.jms.JMSException - If purging the queue fails for any reason.String readFromQueue(String queueName, long timeout, String messageSelector) throws javax.jms.JMSException
queueName - - Name of the queue to read fromtimeout - - Timeout in milliseconds to wait for message to appear into queuemessageSelector - - Optional message selector string for filtering messagesnull if no message was read from the queue.javax.jms.JMSException - If reading the message fails.String readFromTopic(String name, long timeout) throws javax.jms.JMSException
name - - Name of the durable subscription made for the topic or name of the temporary topictimeout - - Timeout in milliseconds to wait for message to appear into topicnull if no message was read from the topic.javax.jms.JMSException - If reading the message fails.MessageTypeEnum resolveMessageType(String messageID)
TEXT, BYTE or MAP.messageID - - Optional message ID. If not given then method attempt to read content from latest read messagevoid subscribeTopic(String topicName, String name, String messageSelector) throws javax.jms.JMSException
topicName - - Name of the topicname - - Unique name for the durable subscriptionmessageSelector - - Optional message selector string for filtering messagesjavax.jms.JMSException - If subscribing the topic fails.void unsubscribeTopic(String name) throws javax.jms.JMSException
name - - Unique subscription name to canceljavax.jms.JMSException - If canceling the subscription fails.void writeIntoQueue(String queueName, String content, Map<String,Object> parameters, Map<String,Object> properties) throws javax.jms.JMSException
queueName - - Name of the queue to writecontent - - Message's contentparameters - - Optional message's JMS parameters.
Key values are defined in MessageParameterNamesproperties - - Optional JMS message propertiesjavax.jms.JMSException - If message creation or write it into queue fails.MessageParameterNamesvoid writeIntoQueue(String queueName, byte[] content, Map<String,Object> parameters, Map<String,Object> properties) throws javax.jms.JMSException
queueName - - Name of the queue to writecontent - - Message's contentparameters - - Optional message's JMS parameters.
Key values are defined in MessageParameterNamesproperties - - Optional JMS message propertiesjavax.jms.JMSException - If message creation or write it into queue fails.MessageParameterNamesvoid writeIntoQueue(String queueName, Map<String,Object> content, Map<String,Object> parameters, Map<String,Object> properties) throws javax.jms.JMSException
queueName - - Name of the queue to writecontent - - Message's contentparameters - - Optional message's JMS parameters.
Key values are defined in MessageParameterNamesproperties - - Optional JMS message propertiesjavax.jms.JMSException - If message creation or write it into queue fails.MessageParameterNamesCopyright © 2018. All rights reserved.