|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SAFDestinationBean
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.
Method Summary | |
---|---|
abstract String |
getLocalJNDIName() The local JNDI name of the remote destination. |
abstract MessageLoggingParamsBean |
getMessageLoggingParams() These parameters control how the SAF destination performs message logging. |
abstract String |
getNonPersistentQos() Specifies the quality-of-service for non-persistent messages. |
abstract String |
getPersistentQos() Specifies the quality-of-service for persistent messages. |
abstract String |
getRemoteJNDIName() The remote JNDI name of the remote destination. |
abstract SAFErrorHandlingBean |
getSAFErrorHandling() Specifies the error handling configuration used by this SAF destination. |
abstract long |
getTimeToLiveDefault() Specifies the default Time-to-Live value (expiration time), in milliseconds, for imported JMS messages. |
abstract String |
getUnitOfOrderRouting() Specifies the type of routing used to find a SAF agent when using the message Unit-of-Order feature. |
abstract 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. |
abstract void |
setLocalJNDIName(String localJndiName) Sets the value of the LocalJNDIName attribute. |
abstract void |
setNonPersistentQos(String NonPersistentQos) Sets the value of the NonPersistentQos attribute. |
abstract void |
setPersistentQos(String persistentQos) Sets the value of the PersistentQos attribute. |
abstract void |
setRemoteJNDIName(String remoteJndiName) Sets the value of the RemoteJNDIName attribute. |
abstract void |
setSAFErrorHandling(SAFErrorHandlingBean safErrorHandling) Sets the value of the SAFErrorHandling attribute. |
abstract void |
setTimeToLiveDefault(long timeToLiveDefault) Sets the value of the TimeToLiveDefault attribute. |
abstract void |
setUnitOfOrderRouting(String unitOfOrderRouting) Sets the value of the UnitOfOrderRouting attribute. |
abstract void |
setUseSAFTimeToLiveDefault(boolean useSafTimeToLiveDefault) Sets the value of the UseSAFTimeToLiveDefault attribute. |
Methods inherited from interface weblogic.j2ee.descriptor.wl.NamedEntityBean |
---|
getId, getName, getNotes, setName, setNotes |
Method Detail |
---|
String getRemoteJNDIName()
The remote JNDI name of the remote destination.
void setRemoteJNDIName(String remoteJndiName) throws IllegalArgumentException
Sets the value of the RemoteJNDIName attribute.
IllegalArgumentException
SAFDestinationBean.getRemoteJNDIName()
String getLocalJNDIName()
The local JNDI name of the remote destination.
void setLocalJNDIName(String localJndiName) throws IllegalArgumentException
Sets the value of the LocalJNDIName attribute.
IllegalArgumentException
SAFDestinationBean.getLocalJNDIName()
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(String persistentQos) throws IllegalArgumentException
Sets the value of the PersistentQos attribute.
IllegalArgumentException
SAFDestinationBean.getPersistentQos()
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(String NonPersistentQos) throws IllegalArgumentException
Sets the value of the NonPersistentQos attribute.
IllegalArgumentException
SAFDestinationBean.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 IllegalArgumentException
Sets the value of the SAFErrorHandling attribute.
IllegalArgumentException
SAFDestinationBean.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 IllegalArgumentException
Sets the value of the TimeToLiveDefault attribute.
IllegalArgumentException
SAFDestinationBean.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 IllegalArgumentException
Sets the value of the UseSAFTimeToLiveDefault attribute.
IllegalArgumentException
SAFDestinationBean.isUseSAFTimeToLiveDefault()
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(String unitOfOrderRouting) throws IllegalArgumentException
Sets the value of the UnitOfOrderRouting attribute.
unitOfOrderRouting
-IllegalArgumentException
SAFDestinationBean.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.
|
Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.2.1) Part Number E55141-01 P4 Change 1723563 on 2015/10/09 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |