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.

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

forceReliability

  • AssuredPersistent

  • BestEffortNonPersistent

  • ExpressNonPersistent

  • ReliableNonPersistent

  • ReliablePersistent

AssuredPersistent

The reliability assigned to a message produced to this destination when an explicit reliability has not been set by the producer.

id

string
Required

The name of the alias queue or alias topic space.

sendAllowed

  • false

  • true

true

Producers can send messages to this destination.

targetDestination

string

Default.Queue

The 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.

fileStore

Messaging file store. Important: Do not delete any of the file store files. Deleting them can lead to corruption of the message store. If any of these files are deleted accidentally, then delete the remaining files and restart the messaging engine. The messaging engine restarts in a clean state, but all messages are lost.

NameTypeDefaultDescription

fileStoreSize

long
Min: 20

400

The 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.

logFileSize

long
Min: 10

10

Size in megabytes of the log file. The log file size cannot exceed half the size of the file store size. For a file store size set to 400 MB, the log file size cannot exceed 200 MB. The maximum recommended log file size is 25% of the file store size. For a file store size set to 400 MB, the maximum recommended setting for log file size would be 100 MB.

path

string

${server.output.dir}/messaging/messageStore

Path to the file store.

messagingSecurity

Security for the wasJmsServer-1.0 feature.

messagingSecurity > role

A set of permissions that are mapped to the users and groups

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string
Required

The name of the role

messagingSecurity > role > group

Groups that are assigned to the role

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string
Required

The group that is defined as part of the user registry

messagingSecurity > role > queuePermission

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

NameTypeDefaultDescription

action

  • ALL

  • BROWSE

  • RECEIVE

  • SEND

Operations that are allowed on the destination

id

string

A unique configuration ID.

queueRef

string
Required

Reference to the Queue defined in the Messaging Engine

messagingSecurity > role > tempDestinationPermission

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

NameTypeDefaultDescription

action

  • ALL

  • CREATE

  • RECEIVE

  • SEND

Operations that are allowed on the destination

id

string

A unique configuration ID.

prefix

string
Required

Prefix defined for a temporary destination

messagingSecurity > role > topicPermission

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

NameTypeDefaultDescription

action

  • ALL

  • RECEIVE

  • SEND

Operations that are allowed on the destination

id

string

A unique configuration ID.

topicName

string

Name of the Topic inside the TopicSpace

topicSpaceRef

string

Default.Topic.Space

Reference to the TopicSpace defined in the Messaging Engine

messagingSecurity > role > user

Users that are assigned to the particular role

NameTypeDefaultDescription

id

string

A unique configuration ID.

name

string
Required

The user that is defined as part of the registry

queue

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

NameTypeDefaultDescription

exceptionDestination

string

_SYSTEM.Exception.Destination

The destination to which a message is forwarded by the system when it cannot be delivered to this destination.

failedDeliveryPolicy

  • DISCARD

  • KEEP_TRYING

  • SEND_TO_EXCEPTION_DESTINATION

SEND_TO_EXCEPTION_DESTINATION

Lists the actions that the messaging engine must take when the maxredeliverycount is reached for a message.

forceReliability

  • AssuredPersistent

  • BestEffortNonPersistent

  • ExpressNonPersistent

  • ReliableNonPersistent

  • ReliablePersistent

AssuredPersistent

The reliability assigned to a message produced to this destination when an explicit reliability has not been set by the producer.

id

string
Required

The name of the queue.

maintainStrictOrder

boolean

false

Maintains the order in which a producer sends messages to the destination.

maxMessageDepth

long
Min: 1

50000

The maximum number of messages that the messaging engine can place on its message points.

maxRedeliveryCount

int

5

The 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.

receiveAllowed

boolean

true

Clear this option (setting it to false) to prevent consumers from being able to receive messages from this destination.

redeliveryInterval

long

5000

When no exception destination is configured, the time interval to apply between retry attempts, after the maximum failed deliveries limit is reached, for this destination.

sendAllowed

boolean

true

Producers can send messages to this destination.

topicSpace

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

NameTypeDefaultDescription

exceptionDestination

string

_SYSTEM.Exception.Destination

The destination to which a message is forwarded by the system when it cannot be delivered to this destination.

failedDeliveryPolicy

  • DISCARD

  • KEEP_TRYING

  • SEND_TO_EXCEPTION_DESTINATION

SEND_TO_EXCEPTION_DESTINATION

Lists the actions that the messaging engine must take when the maxredeliverycount is reached for a message.

forceReliability

  • AssuredPersistent

  • BestEffortNonPersistent

  • ExpressNonPersistent

  • ReliableNonPersistent

  • ReliablePersistent

AssuredPersistent

The reliability assigned to a message produced to this destination when an explicit reliability has not been set by the producer.

id

string
Required

The name of the topic space.

maintainStrictOrder

boolean

false

Maintains the order in which a producer sends messages to the destination.

maxMessageDepth

long
Min: 1

50000

The maximum number of messages that the messaging engine can place on its message points.

maxRedeliveryCount

int

5

The 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.

receiveAllowed

boolean

true

Clear this option (setting it to false) to prevent consumers from being able to receive messages from this destination.

redeliveryInterval

long

5000

When no exception destination is configured, the time interval to apply between retry attempts, after the maximum failed deliveries limit is reached, for this destination.

sendAllowed

boolean

true

Producers can send messages to this destination.