This topic describes the Java methods available for use with objects of the type com.stc.connectors.jms.JMS, and can be accessed from:
The JMS OTD
Input messages for the send web service operation
Output messages for the receive web service operation (new web service)
Creates an empty byte message.
None.
Returns |
Type |
---|---|
The byte message object. |
com.stc.connectors.jms.Message |
None.
Creates a byte message with the specified byte array value.
Name |
Type |
Description |
---|---|---|
msg |
|
The byte array value for the bytes message |
Returns |
Type |
---|---|
The message object with data msg. |
com.stc.connectors.jms.Message |
None.
Creates a map message.
None.
Returns |
Type |
---|---|
The MapMessage object. |
com.stc.connectors.jms.Message |
None.
Creates an empty message (no payload), which is the most efficient method for event notification.
None.
Returns |
Type |
---|---|
The message object. |
com.stc.connectors.jms.Message |
None.
Creates a message of type com.stc.connectors.jms.Message, which wraps around the message variable of type javax.jms.Message.
Name |
Type |
Description |
---|---|---|
msg |
javax.jms.Message |
The message variable. |
Returns |
Type |
---|---|
The message object, with data from JMS Message object. |
com.stc.connectors.jms.Message |
Throws JMSException, IOException.
Creates an empty stream message. Use the method setStreamMessage(arg0, arg1) to add the payload.
None.
Returns |
Type |
---|---|
The stream message object. |
com.stc.connectors.jms.Message |
None.
Creates an empty text message. Use the method setTextMessage(arg0) to add the payload.
None.
Returns |
Type |
---|---|
The TextMessage object. |
com.stc.connectors.jms.Message |
None.
Creates a text message that includes the specified text, producing a ready-to-deliver TextMessage object.
Name |
Type |
Description |
---|---|---|
msg |
String |
The string to populate the msg object with. |
Returns |
Type |
---|---|
The message object with data msg. |
com.stc.connectors.jms.Message |
None.
Gets and returns the value of the JMS delivery mode.
None.
Returns |
Type |
---|---|
The value of the JMS deliveryMode property. |
java.lang.String |
None.
Gets and returns the name of the queue or topic.
None.
Returns |
Type |
---|---|
The message destination name. |
java.lang.String |
None.
Input messages for the receiveWait web service operation.
Gets and returns the value of the message server URL.
None.
Returns |
Type |
---|---|
The value of the message server URL. |
java.lang.String |
None.
Gets and returns the value of the JMS priority.
None.
Returns |
Type |
---|---|
The value of the JMS priority property. |
int |
None.
Gets and returns the specified time period, in milliseconds, following the dispatch time that a message should be retained by the message system.
None.
Returns |
Type |
---|---|
The default time period of the JMS timeToLive property, in milliseconds. |
long |
None.
Receives the next message of type com.stc.connectors.jms.Message that arrives from the destination configured in the Connectivity Map Editor during the specified timeout interval.
Name |
Type |
Description |
---|---|---|
timeout |
|
The number of milliseconds before the receive method times out. |
Returns |
Type |
---|---|
The next message produced, or null if the timeout expires. |
com.stc.connectors.jms.Message |
Throws JMSException.
Receives the next message of type com.stc.connectors.jms.Message that arrives from the specified message destination during the specified timeout interval.
Name |
Type |
Description |
---|---|---|
timeout |
|
The number of milliseconds before the receive method times out. |
destination |
java.lang.String |
The name of the topic or queue from which this method receives messages. |
Returns |
Type |
---|---|
The next message produced, or null if the timeout expires. |
com.stc.connectors.jms.Message |
Throws JMSException.
Receives the next message of type com.stc.connectors.jms.Message, if one is immediately available.
None.
Returns |
Type |
---|---|
The next message produced, or null if no message is available. |
com.stc.connectors.jms.Message |
Throws JMSException.
Receives the next message of type com.stc.connectors.jms.Message from the specified message destination if a message is immediately available.
Name |
Type |
Description |
---|---|---|
destination |
java.lang.String |
The name of the topic or queue from which this method receives messages. |
Returns |
Type |
---|---|
The next message produced, or null if no message is available. |
com.stc.connectors.jms.Message |
Throws JMSException.
Sends a message of type com.stc.connectors.jms.Message to the destination configured in the Connectivity Map Editor, and waits for the reply message by using Topic/QueueRequestor.
Name |
Type |
Description |
---|---|---|
message |
com.stc.connectors.jms.Message |
The message object to send |
Returns |
Type |
---|---|
The reply message. |
com.stc.connectors.jms.Message |
Throws JMSException when a message is null or when the JMS provider fails to send and receive the message due to an internal error.
Sends a message of type com.stc.connectors.jms.Message to the destination configured in the Connectivity Map Editor, and receives the reply message by using Topic/QueueRequestor during the specified timeout interval.
Name |
Type |
Description |
---|---|---|
timeout |
java.lang.long |
The timeout in milliseconds |
message |
com.stc.connectors.jms.Message |
The message object to send |
Returns |
Type |
---|---|
The reply message, if available during the timeout interval. |
com.stc.connectors.jms.Message |
Throws JMSException if a message is null, the JMS provider fails to send and receive the message due to an internal error, or timeout expires.
Sends a message of type com.stc.connectors.jms.Message to the explicitly named destination, and waits for the reply message by using Topic/QueueRequestor.
Name |
Type |
Description |
---|---|---|
message |
com.stc.connectors.jms.Message |
The message object to send |
destName |
java.lang.String |
The destination name |
Returns |
Type |
---|---|
The reply message. |
com.stc.connectors.jms.Message |
Throws JMSException when a message is null, destName is null, or the JMS provider fails to send and receive the message due to an internal error.
Sends a message of type com.stc.connectors.jms.Message to the explicitly named destination, and receives the reply message by using Topic/QueueRequestor.
Name |
Type |
Description |
---|---|---|
timeout |
java.lang.long |
The timeout in milliseconds |
message |
com.stc.connectors.jms.Message |
The message object to send |
destName |
java.lang.String |
The destination name |
Returns |
Type |
---|---|
The reply message, if available during the timeout interval. |
com.stc.connectors.jms.Message |
Throws JMSException when a message is null, destName is null, when the JMS provider fails to send and receive the message due to an internal error, or timeout expires.
Sends a message of type com.stc.connectors.jms.Message to the destination configured in the Connectivity Map Editor, using the JMS session’s default settings for message priority, time to live, and delivery mode.
Name |
Type |
Description |
---|---|---|
message |
com.stc.connectors.jms.Message |
The message variable type to be sent. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type com.stc.connectors.jms.Message to the destination configured in the Connectivity Map Editor, using the values specified for message priority, time to live, and delivery mode.
Name |
Type |
Description |
---|---|---|
message |
com.stc.connectors.jms.Message |
The message variable to be created. |
deliveryMode |
|
The message delivery mode. 1 indicates nonpersistent messages, 2 indicates persistent messages. |
priority |
|
The message priority (0 through 9, with 9 being the highest priority). |
timeToLive |
|
The length of time in milliseconds before the message expires. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type byte[]
to the destination
configured in the Connectivity Map Editor, using the JMS session’s
default settings for message priority, time to live, and delivery
mode.
Name |
Type |
Description |
---|---|---|
payload |
|
The message byte array value. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type byte[]
to the destination
configured in the Connectivity Map Editor, using the specified parameters.
Name |
Type |
Description |
---|---|---|
payload |
|
The byte array value. |
deliveryMode |
|
The message delivery mode. 1 indicates nonpersistent messages, 2 indicates persistent messages. |
priority |
|
The message priority (0 through 9, with 9 being the highest priority). |
timeToLive |
|
The length of time in milliseconds before the message expires. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type byte[]
to the specified
destination, using the JMS session’s default settings for message
priority, time to live, and delivery mode.
Name |
Type |
Description |
---|---|---|
payload |
|
The byte array value. |
destination |
java.lang.String |
The name of the topic or queue from which this method receives messages. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type byte[]
to the destination
configured in the Connectivity Map Editor, using the specified parameters.
Name |
Type |
Description |
---|---|---|
payload |
|
The byte array value. |
deliveryMode |
|
The message delivery mode. 1 indicates non-persistent messages, 2 indicates persistent messages. |
priority |
|
The message priority (0 through 9, with 9 being the highest priority). |
timetolive |
|
The amount in milliseconds before the message expires. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type java.lang.String to the destination configured in the Connectivity Map Editor, using the JMS session’s default settings for message priority, time to live, and delivery mode.
Name |
Type |
Description |
---|---|---|
payload |
java.lang.String |
The text in the message. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type java.lang.String to the destination configured in the Connectivity Map Editor, using the specified parameters.
Name |
Type |
Description |
---|---|---|
payload |
java.lang.String |
The text in the message. |
deliveryMode |
|
The message delivery mode. 1 indicates non-persistent messages, 2 indicates persistent messages. |
priority |
|
The message priority (0 through 9, with 9 being the highest priority). |
timeToLive |
|
The length of time in milliseconds before the message expires. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type java.lang.String to the specified destination, using the JMS session’s default settings for message priority, time to live, and delivery mode.
Name |
Type |
Description |
---|---|---|
payload |
java.lang.String |
The text in the message. |
destination |
java.lang.String |
The name of the topic or queue to which this method should send the message. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type java.lang.String to the specified destination, using the specified parameters.
Name |
Type |
Description |
---|---|---|
payload |
java.lang.String |
The text in the message. |
destination |
java.lang.String |
The name of the topic or queue to which this method should send the message. |
deliveryMode |
|
The message delivery mode. 1 indicates non-persistent messages, 2 indicates persistent messages. |
priority |
|
The message priority (0 through 9, with 9 being the highest priority). |
timeToLive |
|
The length of time in milliseconds before the message expires. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type com.stc.connectors.jms.Message to the specified destination, using the JMS session’s default settings for message priority, time to live, and delivery mode.
Name |
Type |
Description |
---|---|---|
msg |
com.stc.connectors.jms.Message |
The message to be sent. |
destination |
java.lang.String |
The name of the topic or queue to which this method should send the message. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sends a message of type com.stc.connectors.jms.Message to the specified destination, using the specified parameters.
Name |
Type |
Description |
---|---|---|
message |
com.stc.connectors.jms.Message |
The message variable type. |
destination |
java.lang.String |
The name of the topic or queue from which this method receives messages. |
deliveryMode |
|
The message delivery mode. 1 indicates non-persistent messages, 2 indicates persistent messages. |
priority |
|
The message priority (0 through 9, with 9 being the highest priority). |
timeToLive |
|
The length of time in milliseconds before the message expires. |
None.
Throws JMSException if a message is null or if the JMS provider fails to send the message due to an internal error.
Sets the value of the JMS delivery mode.
Name |
Type |
Description |
---|---|---|
arg0 |
java.lang.String |
The value of the JMS deliveryMode property. |
None.
None.
Specifies the queue or topic.
Name |
Type |
Description |
---|---|---|
arg0 |
java.lang.String |
The message destination name. |
None.
None.
Input messages for the receiveWait web service operation.
Sets the value of the message server URL.
Name |
Type |
Description |
---|---|---|
arg0 |
java.lang.String |
The value of the message server URL. |
None.
None.
Sets the value of the JMS priority.
Name |
Type |
Description |
---|---|---|
arg0 |
|
The value of the JMS priority property. |
None.
None.
Sets the default time period, in milliseconds, following the dispatch time that a message should be retained by the message system.
Name |
Type |
Description |
---|---|---|
arg0 |
|
The default time period for the JMS timeToLive property, in milliseconds |
None.
None.