|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.util.jms.JmsWriterFactory
Use this class to create new instances of JmsWriter objects.
The methods are all public static
so that they can be easily called via the
IdM <invoke> script tag.
JmsWriter
Method Summary | |
static JmsWriter |
createJmsQueueWriter(java.util.Map queueWriterOptions)
Create a new JmsWriter instance which will send Messages to a Queue |
static JmsWriter |
createJmsTopicWriter(java.util.Map topicWriterOptions)
Create a new JmsWriter instance which will publish Messages to a Topic |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static JmsWriter createJmsQueueWriter(java.util.Map queueWriterOptions) throws WavesetException
queueWriterOptions
- a Map of configuration options.The table below describes each expected key for the map, and the significance of each key's value.
Key | Value type | Reqd? | Usage |
"jndiProperties" | java.util.List or java.util.Map | no | If null, the initial context is created using the Java system properties. If value is a List, then each String in the List must be of the format <key>=<value>. Most common <key> entries include "java.naming.factory.initial" and "java.naming.provider.url". |
"destinationName" | java.lang.String | yes | The JNDI name of the queue to which messages will be sent |
"factoryName" | java.lang.String | yes | The JNDI name of the queue connection factory |
"userName" | java.lang.String | no | If userName is present, then an authenticated connection will be performed using the userName and password provided. If null, the default identity configured for the factory will be used. |
"password" | java.lang.String or com.waveset.util.EncryptedData | no | Used along with userName to perform an authenticated connection. |
"reliabilityMode" | java.lang.String | yes | Specifies the mechanism used to ensure reliable messaging. The valid
values are "LOCAL", "AUTO", "DUPS_OK", and "CLIENT". "LOCAL" specifies that a local session transaction will be used. "AUTO" specifies that the AUTO_ACK acknowledgment mode is used instead of a transaction. "DUPS_OK" specifies that the DUPS_OK_ACK acknowledgment mode is used instead of a transaction. "CLIENT" specifies that the CLIENT_ACK acknowledgment mode is used instead of a transaction. |
WavesetException
- an error was encountered establishing the JmsWriter. Typically,
this represents a JMS configuration issue.public static JmsWriter createJmsTopicWriter(java.util.Map topicWriterOptions) throws WavesetException
topicWriterOptions
- a Map of configuration options.The table below describes each expected key for the map, and the significance of each key's value.
Key | Value type | Reqd? | Usage |
"jndiProperties" | java.util.List or java.util.Map | no | If null, the initial context is created using the Java system properties. If value is a List, then each String in the List must be of the format <key>=<value>. Most common <key> entries include java.naming.factory.initial and java.naming.provider.url |
"destinationName" | java.lang.String | yes | The JNDI name of the topic to which messages will be sent |
"factoryName" | java.lang.String | yes | The JNDI name of the topic connection factory |
"userName" | java.lang.String | no | If userName is present, then an authenticated connection will be performed using the userName and password provided. If null, the default identity configured for the factory will be used. |
"password" | java.lang.String or com.waveset.util.EncryptedData | no | Used along with userName to perform an authenticated connection. |
"reliabilityMode" | java.lang.String | yes | Specifies the mechanism used to ensure reliable messaging. The valid
values are "LOCAL", "AUTO", "DUPS_OK", and "CLIENT". "LOCAL" specifies that a local session transaction will be used. "AUTO" specifies that the AUTO_ACK acknowledgment mode is used instead of a transaction. "DUPS_OK" specifies that the DUPS_OK_ACK acknowledgment mode is used instead of a transaction. "CLIENT" specifies that the CLIENT_ACK acknowledgment mode is used instead of a transaction. |
WavesetException
- an error was encountered establishing the JmsWriter. Typically,
this represents a JMS configuration issue.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |