Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space WBRIDGE and version 7.8.0

Otp

Tagged Values

<<JMSAlias>>

Multiexcerpt
MultiExcerptNamejms_alias
Tagged ValueDescriptionAllowed Values / Example
acknowledgeMode

Specify the message acknowledge mode.
We recommend using acknowledge mode transacted.


Auto
Multiexcerpt
MultiExcerptNameacknowledgeMode_auto

Each single message sent to a JMS provider will be acknowledged by the JMS provider (not the recipient) after recipience.
Messages received from a JMS provider within an activity are acknowledged irrespective of subsequent activities. Consequently, if an error occurs during the execution of the activity diagram after message receipt, no rollback occurs.

Using Auto acknowledge mode in a model, a client must be prepared for possible loss of messages.

Duplicate
Multiexcerpt
MultiExcerptNameacknowledgeMode_duplicate

Duplicate acknowledge mode corresponds to Auto acknowledge mode. Additionally, the JMS provider may send the message more than once to the same destination.

The receiving application must be tolerant of receiving duplicate messages.

Transacted
Multiexcerpt
MultiExcerptNameacknowledgeMode_transacted

Messages sent to or received from a JMS provider within an activity are acknowledged explicitly after processing. Thus, the activity plays the role of a transactional lock.

Info
iconfalse

If the acknowledgeMode is specified as Transacted , a Bridge JMS client acknowledges a consumed message only after the activity diagram that implements the JMS adapter functionality completes without throwing an exception.
This holds even if the activity diagram receives more then one message from, and/or sends messages to the queue during its execution.

timeToLive

Multiexcerpt
MultiExcerptNametimeToLive

Specify the expiration time of a sent message (refer also to the description of JMSExpiration in JMS Message Header Fields the JMS headers/properties).


selector
Multiexcerpt
MultiExcerptNameselector

Specify a selector to filter the received messages.

Refer to the official Java Message Service Specification for the selector statement syntax.

e.g. JMSType='alpha'

destinationName
Multiexcerpt
MultiExcerptNamedestinationName

Specify the name of the queue or topic.


options
Multiexcerpt
MultiExcerptNameoptions

Specify a list of comma separated options in form of <name>=<value>. These options will be interpreted as native options.

The available options depend on the JMS provider.

e.g. queue.JMSDestination=aTestQueue 

user
Multiexcerpt
MultiExcerptNameuser

Specify the JMS credentials in form of <user>/<password>.

e.g. system/manager 
port
Multiexcerpt
MultiExcerptNameport

Specify the port the JMS provider is listening to.


protocol
Multiexcerpt
MultiExcerptNameprotocol

Protocol used to communicate with the JMS provider. The protocol normally is set automatically.


jndiPath
Multiexcerpt
MultiExcerptNamejndiPath

Specify a path to the JNDI file (.bindings), if a JNDI provider is used and protocol is file.


host
Multiexcerpt
MultiExcerptNamehost

Specify the host name of the JMS provider.

localhostDefault.
any other qualified host name
isJNDIProvider
Multiexcerpt
MultiExcerptNameisJNDIProvider

Specify whether the JMS provider is also a JNDI provider. Default is false if not specified.

true
Multiexcerpt
MultiExcerptNameisJNDIProvider_true

The JMS provider is a JNDI provider.

false
Multiexcerpt
MultiExcerptNameisJNDIPRovider_false

The JMS provider is not a JNDI provider (default).

...

Multiexcerpt
MultiExcerptNamejms_send
NameTypeDirectionMandatoryDescription
connectionInfoJMSConnectionInfoin
Specify the JMS connection details. See type type JMSConnectionInfo for more details.
sendParameterJMSSendParameterin
Specify the send action details. See type JMSReceiveParameter JMSSendParameter for more details.
messageStringStringin((tick))

This parameter contains the JMS message to be send, if it contains a String.

Info
iconfalse

One of messageString, messageBlob, jmsStringMessage or jmsBloblMessage must be specified.

jmsStringMessageJMSStringMessagein((tick))

This parameter contains the JMS message to be send including all message properties, if it is a String message.
See type JMSStringMessage for more details.

Info
iconfalse

One of messageString, messageBlob, jmsStringMessage or jmsBloblMessage must be specified.

messageBlobBlobin((tick))

This parameter contains the JMS message to be send, if it contains a Blob.

Info
iconfalse

One of messageString, messageBlob, jmsStringMessage or jmsBloblMessage must be specified.

jmsBloblMessageJMSBlobMessagein((tick))

This parameter contains the JMS message to be send including all message properties, if it is a Blob message.
See type JMSBlobMessage for more details.

Info
iconfalse

One of messageString, messageBlob, jmsStringMessage or jmsBloblMessage must be specified.

Anchor
header_fields
header_fields

JMS Adapter Header Fields/JMS Properties

JMS Standard

The JMS Message parameter contains the following headers/JMS properties:

Multiexcerpt
MultiExcerptNameheader_fields
NameTypeDescriptionAllowed Values

JMSCorrelationID

String
Multiexcerpt
MultiExcerptNameJMSCorrelationID

A client can use this header field to link one message with another. A typical use is to link a response message with its request message.
You can override JMSCorrelationID with a custom value.


JMSPersistentDeliveryMode

Boolean
Multiexcerpt
MultiExcerptNameJMSPersistentDeliveryMode

This header field contains the delivery mode specified when the message is sent.

true
Multiexcerpt
MultiExcerptNameJMSPersistentDeliveryMode_true

The JMS provider has to take extra care to ensure that the message is not lost in transit due to a JMS provider failure (default).

The JMS provider must deliver the message once and only once.

false
Multiexcerpt
MultiExcerptNameJMSPersistentDeliveryMode_false

The JMS provider may lose the message due to a JMS provider failure.

JMSDestination

String
Multiexcerpt
MultiExcerptNameJMSDestination

This header field contains the destination, to which the message is sent.


JMSExpiration

Integer
Multiexcerpt
MultiExcerptNameJMSExpiration

When a message is sent, its expiration time is calculated as the sum of the time-to-live value specified on the send method and the current GMT value. On return from the send method, the JMSExpiration header field of the message contains this value. When a message is received, its JMSExpiration header field contains the same value.

0
Multiexcerpt
MultiExcerptNameJMSExpiration_0

The JMS does not expire.

>0
Multiexcerpt
MultiExcerptNameJMSExpiration_any

The JMS message expires after the given period of time.

JMSMessageID

String
Multiexcerpt
MultiExcerptNameJMSMessageID

This header field contains a value that uniquely identifies each message sent by a provider. A JMSMessageID is a string value, which should function as a unique key for identifying messages in a historical repository. A provider defines the exact scope of uniqueness.

Combined with JMSCorrelationID , this header field is used to link messages, and thus to implement synchronous messaging.



JMSPriority

Integer
Multiexcerpt
MultiExcerptNameJMSPriority

This header field contains the message’s priority. JMS defines a ten-level priority value, with 0 as the lowest priority and 9 as the highest.

0-4
Multiexcerpt
MultiExcerptNameJMSPriority_normal

The JMS message has a normal priority (4 is the default value).

5-9
Multiexcerpt
MultiExcerptNameJMSPriority_expedited

The JMS message has an expedited priority.

JMSRedelivered

Boolean
Multiexcerpt
MultiExcerptNameJMSRedelivered

If a client receives a message with the JMSRedelivered indicator set to true, it is likely, but not guaranteed, that this message was delivered, but not acknowledged, in the past. In general, a provider must set this message header field to true whenever he redelivers a message.

true
Multiexcerpt
MultiExcerptNameJMSRedelivered_true

The JMS message has been redelivered.

This is an indication to the consuming application that the message may have been delivered in the past and that the application should take extra precautions to prevent duplicate processing.

false
Multiexcerpt
MultiExcerptNameJMSRedelivered_false

The JMS message has not been redelivered.

JMSReplyTo

String
Multiexcerpt
MultiExcerptNameJMSReplyTo

This header field contains the name of a destination, to which the recipient of the message should send a reply. The client sending the message specifies the JMSReplyTo field value.



JMSTimestamp

Integer
Multiexcerpt
MultiExcerptNameJMSTimestamp

This header field contains the time a client passes the message to a provider to be sent. The time is not the actual transmission time of the message; the actual send may occur later due to transactions or other client side queuing of messages.



JMSType

String
Multiexcerpt
MultiExcerptNameJMSType

This header field contains a message type identifier supplied by a client when the message is sent. Some messaging systems require that a message type definition is created for each application message and that each message specifies its type. In order to work with such JMS providers, JMS clients should assign a value to JMSType whether the application makes use of it or not. The assignment of a value ensures that the field is set properly for those providers that require a JMSType valuea JMSType value.



JMSCorrelationIDAsBytesBlobContains the JMSCorrelationID in Blob format.

Custom

The JMS Message parameter contains arrays to define custom headers/JMS properties as name/value pairs (see JMSMessage below).
The following custom headers are provided automatically by the xUML Runtime:

Multiexcerpt
MultiExcerptNameheader_fields_custom
NameTypeDescriptionAllowed Values

X-Transaction-ID

String
Multiexcerpt
MultiExcerptNameX-Transaction-ID

This header field contains a unique transaction ID (see Transaction ID).


JMS Adapter Parameter Types

...

JMSConnectionInfo

ClassAttributeTypeDescriptionAllowed Values
JMSConnectionInfoacknowledgeModeJMSAcknowledgeModes
Multiexcerpt
MultiExcerptNameacknowledgeMode

Message acknowledge mode.
We recommend using acknowledge mode transacted.



Auto
Multiexcerpt include
MultiExcerptNameacknowledgeMode_auto
PageWithExcerpt@self
Duplicate
Multiexcerpt include
MultiExcerptNameacknowledgeMode_duplicate
PageWithExcerpt@self
Transacted
Multiexcerpt include
MultiExcerptNameacknowledgeMode_transacted
PageWithExcerpt@self
nameStringArbitrary name of the JMS session to distinct multiple sessions.
userString

JMS user.


passwordStringJMS user password.
pathString

Multiexcerpt include
MultiExcerptNamejndiPath
PageWithExcerpt@self


protocolString

Multiexcerpt include
MultiExcerptNameprotocol
PageWithExcerpt@self


hostString

Multiexcerpt include
MultiExcerptNamehost
PageWithExcerpt@self


portInteger

Multiexcerpt include
MultiExcerptNameport
PageWithExcerpt@self


propertiesArray of JMSStringPropertyArray of key/value pairs used to specify additional JMS Provider properties (e.g. the message queue using ActiveMQ).

JMSMessage

ClassAttributeTypeDescriptionAllowed Values

JMSMessage

longPropertiesJMSLongPropertyJMS properties.
bytePropertiesJMSBytePropertyJMS properties.
booleanPropertiesJMSBooleanPropertyJMS properties.
doublePropertiesJMSDoublePropertyJMS properties.
stringPropertiesJMSStringPropertyJMS properties.
integerPropertiesJMSIntegerPropertyJMS properties.
floatPropertiesJMSFloatPropertyJMS properties.
shortPropertiesJMSShortPropertyJMS properties.

JMSCorrelationIDString

Multiexcerpt include
MultiExcerptNameJMSCorrelationID
PageWithExcerpt@self


JMSPersistentDeliveryModeBoolean
Multiexcerpt include
MultiExcerptNameJMSPersistentDeliveryMode
PageWithExcerpt@self
true
Multiexcerpt include
MultiExcerptNameJMSPersistentDeliveryMode_true
PageWithExcerpt@self
false
Multiexcerpt include
MultiExcerptNameJMSPersistentDeliveryMode_false
PageWithExcerpt@self
JMSDestinationString

Multiexcerpt include
MultiExcerptNameJMSDestination
PageWithExcerpt@self


JMSExpirationInteger

Multiexcerpt include
MultiExcerptNameJMSExpiration
PageWithExcerpt@self

0

Multiexcerpt include
MultiExcerptNameJMSExpiration_0
PageWithExcerpt@self

>0

Multiexcerpt include
MultiExcerptNameJMSExpiration_any
PageWithExcerpt@self

JMSMessageIDString

Multiexcerpt include
MultiExcerptNameJMSMessageID
PageWithExcerpt@self


JMSPriorityInteger

Multiexcerpt include
MultiExcerptNameJMSPriority
PageWithExcerpt@self

0-4

Multiexcerpt include
MultiExcerptNameJMSPriority_normal
PageWithExcerpt@self

5-9

Multiexcerpt include
MultiExcerptNameJMSPriority_expedited
PageWithExcerpt@self

JMSRedeliveredBoolean
Multiexcerpt include
MultiExcerptNameJMSRedelivered
PageWithExcerpt@self
true
Multiexcerpt include
MultiExcerptNameJMSRedelivered_true
PageWithExcerpt@self
false
Multiexcerpt include
MultiExcerptNameJMSRedelivered_false
PageWithExcerpt@self
JMSReplyToString

Multiexcerpt include
MultiExcerptNameJMSReplyTo
PageWithExcerpt@self


JMSTimestampInteger

Multiexcerpt include
MultiExcerptNameJMSTimestamp
PageWithExcerpt@self


JMSTypeString

Multiexcerpt include
MultiExcerptNameJMSType
PageWithExcerpt@self


JMSCorrelationIDAsBytes

BlobJMSCorrelationID as a Blob.

JMSBlobMessage

ClassAttributeTypeDescriptionAllowed Values
JMSBlobMessagePossible type of a JMS message body. Derives from JMSMessage.
messageBlobBlob message content.

JMSStringMessage

String message content.
ClassAttributeTypeDescriptionAllowed Values
JMSStringMessagePossible type of a JMS message body. Derives from JMSMessage.messageString
messageStringString message content.

JMSReceiveParameter

ClassAttributeTypeDescriptionAllowed Values

JMSReceiveParameter

queueNameStringSpecifies the name of the queue/topic, from which messages are received and is mandatory in order to receive messages
selectorStringUsed to filter the received messages (e.g. JMSType='alpha').
Refer to the official Java Message Service specification for the selector statement syntax.

millisecondsToWait IntegerSpecifies the time the JMS adapter is waiting for a message from the specified queue/topic

JMSSendParameter

ClassAttributeTypeDescriptionAllowed Values
JMSSendParameterqueueNameStringSpecifies the name of the queue/topic, to which messages are sent.
timeToLiveIntegerSpecifies the expiration time of a sent message (refer also to the description of JMSExpiration in JMS Adapter Header Fields the JMS headers/properties).

JMSSessionParameter

ClassAttributeTypeDescriptionAllowed Values
JMSSessionParameteracknowledgeModeJMSAcknowledgeModes

Multiexcerpt include
MultiExcerptNameacknowledgeMode
PageWithExcerpt@self

Auto
Multiexcerpt include
MultiExcerptNameacknowledgeMode_auto
PageWithExcerpt@self
Duplicate
Multiexcerpt include
MultiExcerptNameacknowledgeMode_duplicate
PageWithExcerpt@self
Transacted
Multiexcerpt include
MultiExcerptNameacknowledgeMode_transacted
PageWithExcerpt@self
nameStringArbitrary name of the JMS session to distinct multiple sessions.
connectionFactoryClassStringName of the connection factory class.
connectionFactoryPropertiesJMSStringPropertyProperties of the connection factory.
userStringJMS user.
passwordStringJMS user password.

Custom JMS Properties

ClassAttributeTypeDescriptionAllowed Values

JMSBooleanProperty

keyStringKey of the JMS property.
valueBooleanBoolean property value.

JMSByteProperty
JMSIntegerProperty
JMSLongProperty
JMSShortProperty

keyStringKey of the JMS property.
valueIntegerInteger property value.

JMSDoubleProperty
JMSFloatProperty

keyStringKey of the JMS property.
valueFloatFloat property value.

JMSStringProperty

keyStringKey of the JMS property.
valueStringString property value.

...


JMSAcknowledgeModes

EnumerationTypeValueDescription
JMSAcknowledgeModesStringAuto
Multiexcerpt include
MultiExcerptNameacknowledgeMode_auto
PageWithExcerpt@self
Duplicate
Multiexcerpt include
MultiExcerptNameacknowledgeMode_duplicate
PageWithExcerpt@self
Transacted
Multiexcerpt include
MultiExcerptNameacknowledgeMode_transacted
PageWithExcerpt@self