NamedEntityBean
, SettableBean
SAFQueueBean
, SAFTopicBean
public interface SAFDestinationBean extends NamedEntityBean
Modifier and Type | Method | Description |
---|---|---|
java.lang.String |
getLocalJNDIName() |
The local JNDI name of the remote destination.
|
MessageLoggingParamsBean |
getMessageLoggingParams() |
These parameters control how the SAF destination performs message
logging.
|
java.lang.String |
getNonPersistentQos() |
Specifies the quality-of-service for non-persistent messages.
|
java.lang.String |
getPersistentQos() |
Specifies the quality-of-service for persistent messages.
|
java.lang.String |
getRemoteJNDIName() |
The remote JNDI name of the remote destination.
|
SAFErrorHandlingBean |
getSAFErrorHandling() |
Specifies the error handling configuration used by this SAF destination.
|
long |
getTimeToLiveDefault() |
Specifies the default Time-to-Live value (expiration time), in milliseconds,
for imported JMS messages.
|
java.lang.String |
getUnitOfOrderRouting() |
Specifies the type of routing used to find a SAF agent
when using the message Unit-of-Order feature.
|
boolean |
isUseSAFTimeToLiveDefault() |
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. |
void |
setLocalJNDIName(java.lang.String localJndiName) |
Sets the value of the LocalJNDIName attribute.
|
void |
setNonPersistentQos(java.lang.String NonPersistentQos) |
Sets the value of the NonPersistentQos attribute.
|
void |
setPersistentQos(java.lang.String persistentQos) |
Sets the value of the PersistentQos attribute.
|
void |
setRemoteJNDIName(java.lang.String remoteJndiName) |
Sets the value of the RemoteJNDIName attribute.
|
void |
setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling) |
Sets the value of the SAFErrorHandling attribute.
|
void |
setTimeToLiveDefault(long timeToLiveDefault) |
Sets the value of the TimeToLiveDefault attribute.
|
void |
setUnitOfOrderRouting(java.lang.String unitOfOrderRouting) |
Sets the value of the UnitOfOrderRouting attribute.
|
void |
setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault) |
Sets the value of the UseSAFTimeToLiveDefault attribute.
|
java.lang.String getRemoteJNDIName()
The remote JNDI name of the remote destination.
void setRemoteJNDIName(java.lang.String remoteJndiName) throws java.lang.IllegalArgumentException
Sets the value of the RemoteJNDIName attribute.
java.lang.IllegalArgumentException
getRemoteJNDIName()
java.lang.String getLocalJNDIName()
The local JNDI name of the remote destination.
void setLocalJNDIName(java.lang.String localJndiName) throws java.lang.IllegalArgumentException
Sets the value of the LocalJNDIName attribute.
java.lang.IllegalArgumentException
getLocalJNDIName()
java.lang.String getPersistentQos()
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.
void setPersistentQos(java.lang.String persistentQos) throws java.lang.IllegalArgumentException
Sets the value of the PersistentQos attribute.
java.lang.IllegalArgumentException
getPersistentQos()
java.lang.String getNonPersistentQos()
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.
void setNonPersistentQos(java.lang.String NonPersistentQos) throws java.lang.IllegalArgumentException
Sets the value of the NonPersistentQos attribute.
java.lang.IllegalArgumentException
getNonPersistentQos()
SAFErrorHandlingBean getSAFErrorHandling()
Specifies the error handling configuration used by this SAF destination.
Any change to this parameter affects only incoming messages; stored messages are not affected.
void setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling) throws java.lang.IllegalArgumentException
Sets the value of the SAFErrorHandling attribute.
java.lang.IllegalArgumentException
getSAFErrorHandling()
long getTimeToLiveDefault()
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.
void setTimeToLiveDefault(long timeToLiveDefault) throws java.lang.IllegalArgumentException
Sets the value of the TimeToLiveDefault attribute.
java.lang.IllegalArgumentException
getTimeToLiveDefault()
boolean isUseSAFTimeToLiveDefault()
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.
void setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault) throws java.lang.IllegalArgumentException
Sets the value of the UseSAFTimeToLiveDefault attribute.
java.lang.IllegalArgumentException
isUseSAFTimeToLiveDefault()
java.lang.String getUnitOfOrderRouting()
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.
void setUnitOfOrderRouting(java.lang.String unitOfOrderRouting) throws java.lang.IllegalArgumentException
Sets the value of the UnitOfOrderRouting attribute.
unitOfOrderRouting
- java.lang.IllegalArgumentException
getUnitOfOrderRouting()
MessageLoggingParamsBean getMessageLoggingParams()
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.