Package com.bea.wli.sb.transports

Class TransportOptions

java.lang.Object
com.bea.wli.sb.transports.TransportOptions
public class TransportOptions extends Object
Used to supply options for sending or receiving a message. Possibly other usages in the future. There are two styles for using TransportOptions: multi-line setup, and single-line use. Here are two examples. First, multi-line style: 
 TransportOptions opts = new TransportOptions();
  opts.setQoS(EXACTLY_ONCE);
  opts.setThrowOnError(true);
The alternative is single-line usage: 
 new TransportOptions().setQoS(EXACTLY_ONCE).setThrowOnError()));

  • Field Details

    • QOS

      public static final String QOS
      Deprecated.
      use Option.QOS

    • THROW_ON_ERROR

      public static final String THROW_ON_ERROR
      Deprecated.
      use Option.THROW_ON_ERROR

    • MODE

      public static final String MODE
      Deprecated.
      use Option.MODE

    • _URI

      public static final String _URI
      Deprecated.
      use Option.URI

    • RETRY_INTERVAL

      public static final String RETRY_INTERVAL
      Deprecated.
      use Option.RETRY_INTERVAL

    • RETRY_COUNT

      public static final String RETRY_COUNT
      Deprecated.
      use Option.RETRY_COUNT

    • OPERATION_NAME

      public static final String OPERATION_NAME
      Deprecated.
      use Option.OPERATION_NAME

    • INBOUND_ENDPOINT

      public static final String INBOUND_ENDPOINT
      Deprecated.
      use Option.INBOUND_ENDPOINT

    • OPAQUE_DATA

      public static final String OPAQUE_DATA
      Deprecated.
      use Option.OPAQUE_DATA

    • MESSAGE_PRIORITY

      public static final String MESSAGE_PRIORITY
      Deprecated.
      use Option.MESSAGE_PRIORITY

    • BLOCKING_THROTTLING

      public static final String BLOCKING_THROTTLING
      Deprecated.
      use Option.BLOCKING_THROTTLING

    • REPLY_WITH_FAILURE

      public static final String REPLY_WITH_FAILURE
      Deprecated.
      use Option.REPLY_WITH_FAILURE

    • REPLY_SYNC

      public static final String REPLY_SYNC
      Deprecated.
      use Option.REPLY_SYNC

    • CONTENT_STREAMING

      public static final String CONTENT_STREAMING
      Deprecated.
      use Option.CONTENT_STREAMING

    • DEFAULT_PRIORITY

      public static final int DEFAULT_PRIORITY
      See Also:

  • Constructor Details

    • TransportOptions

      public TransportOptions()

  • Method Details

    • setQoS

      public TransportOptions setQoS(TransportOptions.QoSEnum val)
      specifies whether or not "exactly-once" qualify of service can be achieved. In case of transport providers that support transactional semantics this means whether transaction will be rolled back in case of an error.
      Parameters:
      val - quality of service enum
      Returns:
      updated transport options instance.

    • getQoS

      public TransportOptions.QoSEnum getQoS()
      Returns:
      whether or not "exactly-once" quality of service can be achieved. In case of transport providers that support transactional semantics this means whether transaction will be rolled back in case of an error.

    • setMode

      public TransportOptions setMode(TransportOptions.ModeEnum val)
      specifies the type of the message being processed by OSB - one-way or request/response.
      Parameters:
      val - mode
      Returns:
      updated transport options instance.

    • getMode

      public TransportOptions.ModeEnum getMode()
      Returns:
      the type of the message being processed by OSB - one-way or request/response.

    • setThrowOnError

      public 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. The callee will presumably mark the current transaction for rollback. Otherwise, the router manager will send an appropriate response (e.g. a SOAP fault) in the inbound message context instead of throwing an exception.
      Returns:
      updated transport options instance.

    • isThrowOnError

      public boolean isThrowOnError()
      Returns:
      whether or not an exception will be thrown to the callee of method TransportManager.receiveMessage() due to an error that occurs during the OSB pipeline processing.

    • setBlockingThrottling

      public TransportOptions setBlockingThrottling()

    • isBlockingThrottling

      public boolean isBlockingThrottling()

    • isReplyWithFailure

      public boolean isReplyWithFailure()
      Returns:
      whether or not the user has chosen to reply with failure in the message flow of the service. This option gets set by the pipeline runtime and is passed to the inbound transport message context via the close() method

    • setReplyWithFailure

      public TransportOptions setReplyWithFailure()

    • isReplySync

      public boolean isReplySync()
      Returns:
      whether or not the the response comes in a synchronous fashion. This option gets set by the pipeline runtime when the user enables 'use same Transaction For Response' flag and is passed to the inbound transport message context via the close() method

    • isContentStreamingEnabled

      public boolean isContentStreamingEnabled()
      Returns:
      whether or not outbound request and/or inbound response is used in a context of large messages (i.e. with content streaming enabled option)

    • setURI

      public TransportOptions setURI(URI val)
      specifies which URI is to be used when sending outbound requests via a transport provider
      Parameters:
      val - uri
      Returns:
      updated transport options instance

    • getURI

      public URI getURI()
      Returns:
      which URI is to be used when sending outbound requests via a transport provider

    • setRetryInterval

      public TransportOptions setRetryInterval(int val)
      specifies the retry interval is to used in case of delivery failure when sending outbound requests via a transport provider. If present, it overrides the service configuration setting
      Parameters:
      val - retry interval
      Returns:
      updated transports options instance.

    • getRetryInterval

      public int getRetryInterval()
      Returns:
      the retry interval is to used in case of delivery failure when sending outbound requests via a transport provider.

    • setRetryCount

      public TransportOptions setRetryCount(int val)
      specifies the retry count is to used in case of delivery failure when sending outbound requests via a transport provider. If present, it overrides the service configuration setting
      Parameters:
      val - retry count
      Returns:
      updated transports options instance.

    • getRetryCount

      public int getRetryCount()
      Returns:
      the retry count is to used in case of delivery failure when sending outbound requests via a transport provider. If present, it overrides the service configuration setting

    • setOperationName

      public TransportOptions setOperationName(String val)
      specifies the name of the Web Service operation, when applicable for outbound requests. It is set my OSB runtime and passed to transport provider.
      Parameters:
      val - operation name
      Returns:
      updated transports options instance.

    • getOperationName

      public String getOperationName()
      Returns:
      the name of the Web Service operation, when applicable for outbound requests. It is set my OSB runtime and passed to transport provider.

    • setMessagePriority

      public TransportOptions setMessagePriority(int priority)

    • getMessagePriority

      public int getMessagePriority()

    • setOpaqueData

      public TransportOptions setOpaqueData(Map<String,Object> data)
      Stores opaque (i.e. unspecified/unstructured) data from transport providers. A typical use case is when a transport provider XYZ receives an inbound message, passes it to OSB along with some opaque data and OSB eventually delivers this data to the outbound transport provider, which also happens to be XYZ so it knows precisely how to interpret the data.
      Parameters:
      data - opaque data, a map of object keyed by string.
      Returns:
      updated transport options instance

    • getOpaqueData

      public Map<String,Object> getOpaqueData()
      Returns:
      opaque (i.e. unspecified/unstructured) data from transport providers.

    • hasOption

      public boolean hasOption(TransportOptions.Option option)
      Parameters:
      option - option key
      Returns:
      whether or not an options with a given key exists

    • hasOption

      public boolean hasOption(Object key)
      Parameters:
      key - option key
      Returns:
      whether or not an options with a given key exists

    • get

      public Object get(TransportOptions.Option option)
      Parameters:
      option - option key
      Returns:
      the value of the option with a given key

    • get

      public Object get(Object key)
      Parameters:
      key - option key
      Returns:
      the value of the option with a given key

    • put

      public TransportOptions put(TransportOptions.Option option)
      Parameters:
      option - option key
      Returns:
      updated transport options instance set the value of the option with a given key to true

    • put

      public TransportOptions put(Object option)
      Parameters:
      option - option key
      Returns:
      updated transport options instance set the value of the option with a given key to true

    • put

      public TransportOptions put(Object option, int value)
      set the value of the option with a given key to specified value
      Parameters:
      option - object representing the option key
      value - int value for the given key
      Returns:
      updated transport options instance

    • put

      public TransportOptions put(Object option, Object value)
      set the value of the option with a given key to specified value
      Parameters:
      option - object representing the option key
      value - object value for the given key
      Returns:
      updated transport options instance

    • remove

      public TransportOptions remove(TransportOptions.Option option)
      delete of the option with a given key
      Parameters:
      option - key

    • remove

      public void remove(Object key)
      delete of the option with a given key
      Parameters:
      key - key

    • safeGet

      public static Object safeGet(TransportOptions options, Object option)
      utility method
      Parameters:
      option - key
      options - transport options to introspect
      Returns:
      the value of the option with a given key

    • hasOption

      public static boolean hasOption(TransportOptions options, Object option)
      utility method
      Parameters:
      option - key
      options - transport options to introspect
      Returns:
      whether or not the option with a given key exists

    • toString

      public String toString()
      Overrides:
      toString in class Object
      Returns:
      string representation of this TransportOptions object