|
Oracle Fusion Middleware Java API Reference for Oracle Service Bus 11g Release 1 (11.1.1.6.3) E15033-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.wli.sb.transports.TransportOptions
public class TransportOptions
Used to supply options for sending or receiving a message. Possibly other usages in the future. There are two styles for using TransportOptions: multiline setup, and single-line use. Here are two examples. First, multiline style:
TransportOptions opts = new TransportOptions(); opts.setQoS(EXACTLY_ONCE); opts.setThrowOnError(true);
The alternative is single-line usage:
new TransportOptions().setQoS(EXACTLY_ONCE).setThrowOnError()));
Nested Class Summary | |
---|---|
static class |
TransportOptions.ModeEnum |
static class |
TransportOptions.QoSEnum |
Field Summary | |
---|---|
static java.lang.String |
_URI |
static java.lang.String |
BLOCKING_THROTTLING |
static int |
DEFAULT_PRIORITY |
static java.lang.String |
INBOUND_ENDPOINT |
static java.lang.String |
MESSAGE_PRIORITY |
static java.lang.String |
MODE |
static java.lang.String |
OPAQUE_DATA |
static java.lang.String |
OPERATION_NAME |
static java.lang.String |
QOS |
static java.lang.String |
REPLY_SYNC |
static java.lang.String |
REPLY_WITH_FAILURE |
static java.lang.String |
RETRY_COUNT |
static java.lang.String |
RETRY_INTERVAL |
static java.lang.String |
THROW_ON_ERROR |
Constructor Summary | |
---|---|
TransportOptions() |
Method Summary | |
---|---|
java.lang.Object |
get(java.lang.Object option) |
int |
getMessagePriority() |
TransportOptions.ModeEnum |
getMode() |
java.util.Map<java.lang.String,java.lang.Object> |
getOpaqueData() |
java.lang.String |
getOperationName() |
TransportOptions.QoSEnum |
getQoS() |
int |
getRetryCount() |
int |
getRetryInterval() |
java.net.URI |
getURI() |
boolean |
hasOption(java.lang.Object option) |
static boolean |
hasOption(TransportOptions options, java.lang.Object option) utility method |
boolean |
isBlockingThrottling() |
boolean |
isReplySync() |
boolean |
isReplyWithFailure() |
boolean |
isThrowOnError() |
TransportOptions |
put(java.lang.Object option) |
TransportOptions |
put(java.lang.Object option, int value) set the value of the option with a given key to specified value |
TransportOptions |
put(java.lang.Object option, java.lang.Object value) set the value of the option with a given key to specified value |
void |
remove(java.lang.Object option) delete of the option with a given key |
static java.lang.Object |
safeGet(TransportOptions options, java.lang.Object option) utility method |
TransportOptions |
setBlockingThrottling() |
TransportOptions |
setMessagePriority(int priority) |
TransportOptions |
setMode(TransportOptions.ModeEnum val) specifies the type of the message being processed by OSB - one-way or request/response. |
TransportOptions |
setOpaqueData(java.util.Map<java.lang.String,java.lang.Object> data) Stores opaque (i.e. |
TransportOptions |
setOperationName(java.lang.String val) specifies the name of the Web Service operation, when applicable for outbound requests. |
TransportOptions |
setQoS(TransportOptions.QoSEnum val) specifies whether or not “exactly-once” qualify of service can be achieved. |
TransportOptions |
setReplyWithFailure() |
TransportOptions |
setRetryCount(int val) specifies the retry count is to used in case of delivery failure when sending outbound requests via a transport provider. |
TransportOptions |
setRetryInterval(int val) specifies the retry interval is to used in case of delivery failure when sending outbound requests via a transport provider. |
TransportOptions |
setThrowOnError() if set, an exception will be thrown to the callee of method TransportManager.receiveMessage() due to an error that occurs during the OSB pipeline processing. |
TransportOptions |
setURI(java.net.URI val) specifies which URI is to be used when sending outbound requests via a transport provider |
java.lang.String |
toString() |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String QOS
public static final java.lang.String THROW_ON_ERROR
public static final java.lang.String MODE
public static final java.lang.String _URI
public static final java.lang.String RETRY_INTERVAL
public static final java.lang.String RETRY_COUNT
public static final java.lang.String OPERATION_NAME
public static final java.lang.String INBOUND_ENDPOINT
public static final java.lang.String OPAQUE_DATA
public static final java.lang.String MESSAGE_PRIORITY
public static final java.lang.String BLOCKING_THROTTLING
public static final java.lang.String REPLY_WITH_FAILURE
public static final java.lang.String REPLY_SYNC
public static final int DEFAULT_PRIORITY
Constructor Detail |
---|
public TransportOptions()
Method Detail |
---|
public TransportOptions setQoS(TransportOptions.QoSEnum val)
val
- quality of service enumpublic TransportOptions.QoSEnum getQoS()
public TransportOptions setMode(TransportOptions.ModeEnum val)
val
- modepublic TransportOptions.ModeEnum getMode()
public TransportOptions setThrowOnError()
public boolean isThrowOnError()
public TransportOptions setBlockingThrottling()
public boolean isBlockingThrottling()
public boolean isReplyWithFailure()
public TransportOptions setReplyWithFailure()
public boolean isReplySync()
public TransportOptions setURI(java.net.URI val)
val
- uripublic java.net.URI getURI()
public TransportOptions setRetryInterval(int val)
val
- retry intervalpublic int getRetryInterval()
public TransportOptions setRetryCount(int val)
val
- retry countpublic int getRetryCount()
public TransportOptions setOperationName(java.lang.String val)
val
- operation namepublic java.lang.String getOperationName()
public TransportOptions setMessagePriority(int priority)
public int getMessagePriority()
public TransportOptions setOpaqueData(java.util.Map<java.lang.String,java.lang.Object> data)
data
- opaque data, a map of object keyed by string.public java.util.Map<java.lang.String,java.lang.Object> getOpaqueData()
public boolean hasOption(java.lang.Object option)
option
- option keypublic java.lang.Object get(java.lang.Object option)
option
- option keypublic TransportOptions put(java.lang.Object option)
option
- option keypublic TransportOptions put(java.lang.Object option, int value)
option
- object representing the option keyvalue
- int value for the given keypublic TransportOptions put(java.lang.Object option, java.lang.Object value)
option
- object representing the option keyvalue
- object value for the given keypublic void remove(java.lang.Object option)
option
- keypublic static java.lang.Object safeGet(TransportOptions options, java.lang.Object option)
option
- keyoptions
- transport options to introspectpublic static boolean hasOption(TransportOptions options, java.lang.Object option)
option
- keyoptions
- transport options to introspectpublic java.lang.String toString()
toString
in class java.lang.Object
|
Oracle Fusion Middleware Java API Reference for Oracle Service Bus 11g Release 1 (11.1.1.6.3) E15033-08 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |