SAFDestinationBean

Overview

Store-and-Forward (SAF) destinations are used for asynchronous and disconnected peer communications. A message delivered to a SAF queue or a SAF topic will be forwarded to a queue or a topic in a remote cluster or server. Aspects of a SAF queues and topics behavior can be configured with a SAF queue or topic bean.

Related MBeans

This section describes attributes that provide access to other MBeans.

MessageLoggingParams

These parameters control how the SAF destination performs message logging.

They allow the adminstrator to configure the SAF destination to change message logging when message life cycle changes are detected.

SAFErrorHandling

Specifies the error handling configuration used by this SAF destination.

Any change to this parameter affects only incoming messages; stored messages are not affected.

Attributes

This section describes the following attributes:

Id

Return the unique identifier of this bean instance.

LocalJNDIName

The local JNDI name of the remote destination.

Name

The name of this entity, represented in XML as an attribute.

Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

This attribute cannot be modified externally from the module (for example, with a deployment plan) because it may be used inside the module referentially.

NonPersistentQos

Specifies the quality-of-service for non-persistent messages.

• Exactly-Once indicates that messages will be forwarded to the remote side once and only once except for any occurrence of server crashes.

• At-Least-Once indicates that messages will be forwarded to the remote side at least once. No message will be lost except for any occurrence of server crashes. However, messages may appear in the remote endpoint more than once.

• At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.

Any change to this parameter affects only incoming messages; stored messages are not affected.

Notes

Optional information that you can include to describe this named JMS descriptor bean.

JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity <. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

PersistentQos

Specifies the quality-of-service for persistent messages.

• Exactly-Once indicates that messages will be forwarded to the remote side once and only once

• At-Least-Once indicates that messages will be forwarded to the remote side at least once. Messages may appear in the remote endpoint more than once.

• At-Most-Once indicates that messages will be forwarded to the remote side atmost once. No message will appear in the remote endpoint more than once. However, messages may get lost.

Any change to this parameter affects only incoming messages; stored messages are not affected.

RemoteJNDIName

The remote JNDI name of the remote destination.

TimeToLiveDefault

Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. The expiration time set on JMS messages will override this value unless the SAF Default Time-to-Live Enabled field is switched on, which then overrides the expiration time in JMS messages on imported destinations.

Any change to this value affects only incoming messages; stored messages are not affected.

UnitOfOrderRouting

Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature.

• Hash indicates that producers use the hash code of a message Unit-of-Order to find a SAF agent.

• PathService indicates that producers use the Path Service to find a SAF agent.

UseSAFTimeToLiveDefault

Controls whether the Time-to-Live (expiration time) value set on imported JMS messages will be overridden by the value specified in the SAF Default Time-to-Live field.

Any change to this parameter affects only incoming messages; stored messages are not affected.

Operations

This section describes the following operations:

isSet

Return true if the given property has been explicitly set in this bean.

unSet

Restore the given property to its default value.