messagingEngine - Messaging Engine (messagingEngine)

A messaging engine is a component, running inside a server, that manages messaging resources. Applications are connected to a messaging engine when they send and receive messages.

Messaging file store.

NameTypeDefaultDescription
pathstring${server.output.dir}/messaging/messageStorePath to the file store.
logFileSizelong
Min: 10
10Size in megabytes of the log file. The log file size can be utmost half of the size of the file store. The recommended log file size is 25% of the file store size. For example, if the file store size is set to 400 MB then the log file size cannot exceed more than 200 MB. In this example the recommended value for the log file size will be 100 MB.
fileStoreSizelong
Min: 20
400The combined size in megabytes for both permanent and temporary store. The file store size is equally divided between permanent and temporary store. For example, if you specify 400 MB as file store size then 200 MB is used for permanent store and 200 MB is used for temporary store.

queue

A queue destination represents a message queue and is used for point-to-point messaging.

NameTypeDefaultDescription
idstringThe name of the queue.
forceReliability
  • AssuredPersistent
  • BestEffortNonPersistent
  • ReliableNonPersistent
  • ExpressNonPersistent
  • ReliablePersistent
AssuredPersistentThe reliability assigned to a message produced to this destination when an explicit reliability has not been set by the producer.
AssuredPersistent
AssuredPersistent
BestEffortNonPersistent
BestEffortNonPersistent
ReliableNonPersistent
ReliableNonPersistent
ExpressNonPersistent
ExpressNonPersistent
ReliablePersistent
ReliablePersistent
exceptionDestinationstring_SYSTEM.Exception.DestinationThe destination to which a message is forwarded by the system when it cannot be delivered to this destination.
failedDeliveryPolicy
  • KEEP_TRYING
  • SEND_TO_EXCEPTION_DESTINATION
  • DISCARD
SEND_TO_EXCEPTION_DESTINATIONLists the actions that the messaging engine must take when the maxredeliverycount is reached for a message.
KEEP_TRYING
KEEP_TRYING
SEND_TO_EXCEPTION_DESTINATION
SEND_TO_EXCEPTION_DESTINATION
DISCARD
DISCARD
redeliveryIntervallong5000When no exception destination is configured, the time interval to apply between retry attempts, after the maximum failed deliveries limit is reached, for this destination.
maxRedeliveryCountint5The maximum number of failed attempts to process a message. After this number of failed attempts, if an exception destination is configured, the message is forwarded from the intended destination to its exception destination. If an exception destination is not configured, a time interval between retry attempts is applied.
sendAllowedbooleantrueProducers can send messages to this destination.
receiveAllowedbooleantrueClear this option (setting it to false) to prevent consumers from being able to receive messages from this destination.
maintainStrictOrderbooleanfalseMaintains the order in which a producer sends messages to the destination.
maxMessageDepthlong
Min: 1
50000The maximum number of messages that the messaging engine can place on its message points.

topicSpace

A topic space destination represents a set of "publish and subscribe" topics and is used for publish/subscribe messaging.

NameTypeDefaultDescription
idstringThe name of the topic space.
forceReliability
  • AssuredPersistent
  • BestEffortNonPersistent
  • ReliableNonPersistent
  • ExpressNonPersistent
  • ReliablePersistent
AssuredPersistentThe reliability assigned to a message produced to this destination when an explicit reliability has not been set by the producer.
AssuredPersistent
AssuredPersistent
BestEffortNonPersistent
BestEffortNonPersistent
ReliableNonPersistent
ReliableNonPersistent
ExpressNonPersistent
ExpressNonPersistent
ReliablePersistent
ReliablePersistent
exceptionDestinationstring_SYSTEM.Exception.DestinationThe destination to which a message is forwarded by the system when it cannot be delivered to this destination.
failedDeliveryPolicy
  • KEEP_TRYING
  • SEND_TO_EXCEPTION_DESTINATION
  • DISCARD
SEND_TO_EXCEPTION_DESTINATIONLists the actions that the messaging engine must take when the maxredeliverycount is reached for a message.
KEEP_TRYING
KEEP_TRYING
SEND_TO_EXCEPTION_DESTINATION
SEND_TO_EXCEPTION_DESTINATION
DISCARD
DISCARD
redeliveryIntervallong5000When no exception destination is configured, the time interval to apply between retry attempts, after the maximum failed deliveries limit is reached, for this destination.
maxRedeliveryCountint5The maximum number of failed attempts to process a message. After this number of failed attempts, if an exception destination is configured, the message is forwarded from the intended destination to its exception destination. If an exception destination is not configured, a time interval between retry attempts is applied.
sendAllowedbooleantrueProducers can send messages to this destination.
receiveAllowedbooleantrueClear this option (setting it to false) to prevent consumers from being able to receive messages from this destination.
maintainStrictOrderbooleanfalseMaintains the order in which a producer sends messages to the destination.
maxMessageDepthlong
Min: 1
50000The maximum number of messages that the messaging engine can place on its message points.

alias

An alias destination maps an alternative name for a bus destination. You can use an alias destination for point-to-point messaging or publish/subscribe messaging.

NameTypeDefaultDescription
idstringThe name of the alias queue or alias topic space.
targetDestinationstringDefault.QueueThe target destination parameter identifies a destination that might be within the same Bus as the alias destination. By default, if no property is set, it points to Default.Queue.
forceReliability
  • AssuredPersistent
  • BestEffortNonPersistent
  • ReliableNonPersistent
  • ExpressNonPersistent
  • ReliablePersistent
AssuredPersistentThe reliability assigned to a message produced to this destination when an explicit reliability has not been set by the producer.
AssuredPersistent
AssuredPersistent
BestEffortNonPersistent
BestEffortNonPersistent
ReliableNonPersistent
ReliableNonPersistent
ExpressNonPersistent
ExpressNonPersistent
ReliablePersistent
ReliablePersistent
sendAllowed
  • false
  • true
trueProducers can send messages to this destination.
false
false
true
true

messagingSecurity

Security for the wasJmsServer-1.0 feature.

messagingSecurity > role

A set of permissions mapped to the users and groups

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe name of the role

messagingSecurity > role > queuePermission

Permission defined on a queue for a set of users and groups

NameTypeDefaultDescription
idstringA unique configuration ID.
queueRefstringReference to the Queue defined in the Messaging Engine

messagingSecurity > role > queuePermission > action

Operations which are allowed on the destination

messagingSecurity > role > tempDestinationPermission

Permission defined on a temporary destination for a set of users and groups

NameTypeDefaultDescription
idstringA unique configuration ID.
prefixstringPrefix defined for a temporary destination

messagingSecurity > role > tempDestinationPermission > action

Operations which are allowed on the destination

messagingSecurity > role > topicPermission

Permission defined on a topic for a set of users and groups

NameTypeDefaultDescription
idstringA unique configuration ID.
topicNamestringName of the Topic inside the TopicSpace
topicSpaceRefstringDefault.Topic.SpaceReference to the TopicSpace defined in the Messaging Engine

messagingSecurity > role > topicPermission > action

Operations which are allowed on the destination

messagingSecurity > role > user

Users that are assigned to the particular role

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe user that is defined as part of the registry

messagingSecurity > role > group

Groups that are assigned to the role

NameTypeDefaultDescription
idstringA unique configuration ID.
namestringThe group that is defined as part of the user registry