Package com.bea.wli.sb.transports

Class TransportException

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.bea.wli.sb.transports.TransportException
All Implemented Interfaces:
Serializable
public class TransportException extends Exception
Represents an exception within the OSB Transport subsystem (either in a specific transport provider or in the transport framework itself). A transport exception can be optionally initialized with a combination of error message, code and cause.

If set, the error code is usually one of:

  • TransportManager.TRANSPORT_ERROR_GENERIC
  • TransportManager.TRANSPORT_ERROR_CONNECTION
  • TransportManager.TRANSPORT_ERROR_APPLICATION
    • The usage of the source errorPayload is deprecated. In case of error in the outbound transport call, a transport provider may throw a TransportException and propagate the error back to the pipeline instead of scheduling the callback TransportSendListener.onError(OutboundTransportMessageContext, String, String) If the inbound transport endpoint at the other end of the pipeline is soap service, and unless an error handler customizes the response, the error code and error message will appear in the soap fault

    Since 11.1.1.4, instances of this class can also specify additional metadata that can be interpreted by the pipeline and/or inbound transport. For more info, see setJavaFault(java.lang.Throwable) and setOpaqueData(java.util.Map<java.lang.String, java.lang.Object>)

    See Also:

    • Constructor Details

      • TransportException

        public TransportException()
        Constructs a TransportException.

      • TransportException

        public TransportException(String msg)
        Constructs a TransportException with the specified message text.
        Parameters:
        msg - Message text.

      • TransportException

        public TransportException(String msg, String errorCode)
        Constructs a TransportException with the specified message text and specified error code
        Parameters:
        msg - Message text.
        errorCode - error code

      • TransportException

        public TransportException(String message, Throwable cause)
        Constructs a TransportException with the specified detail message and cause.
        Parameters:
        message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
        cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

      • TransportException

        public TransportException(String message, Throwable cause, String errorCode)
        Constructs a TransportException with the specified detail message and cause and error code.
        Parameters:
        message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).
        cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
        errorCode - error code

      • TransportException

        public TransportException(Throwable cause)
        Constructs a TransportException with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than wrappers for other throwables (for example, PrivilegedActionException).
        Parameters:
        cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

      • TransportException

        public TransportException(Throwable cause, String errorCode)
        Constructs a TransportException with the specified cause and error code.
        Parameters:
        cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
        errorCode - error code

      • TransportException

        public TransportException(String message, Source errorPayload)
        Deprecated.
        Parameters:
        message - error message
        errorPayload - error payload source

      • TransportException

        public TransportException(com.bea.alsb.common.catalog.CatalogMessage message)

      • TransportException

        public TransportException(com.bea.alsb.common.catalog.CatalogMessage message, Throwable cause)

    • Method Details

      • getErrorPayload

        @Deprecated public Source getErrorPayload()
        Deprecated.
        Returns:
        error payload for transport exception

      • getErrorCode

        public String getErrorCode()

      • newInstance

        public static TransportException newInstance(Throwable cause)
        Most transport SDK API signatures declare only TransportException to be thrown. This utility method will wrap any Transport or non-Transport exception appropriately in a TransportException. Typical usage is 
          void someAPI()
     throws TransportException
  {
     try
     {
        ....
     }
     catch (Exception e)
     {
        throw TransportException.newInstance(e);
     }
  }
        Parameters:
        cause - original cause of the exception
        Returns:
        new TransportException that wraps the original cause

      • setJavaFault

        public TransportException setJavaFault(Throwable fault)
        When throwing an exception on the request thread, instruct the pipeline to add a throwable to the $fault variable. This is typically used by Outbound Transport Endpoint of service type BindingTypeInfo.MessageTypeEnum.JAVA. This method is not thread-safe.
        Parameters:
        fault - throwable
        Returns:
        current TransportException instance
        Since:
        11.1.1.4

      • getJavaFault

        public Throwable getJavaFault()
        Get the java fault metadata. See also setJavaFault(java.lang.Throwable) This method is not thread safe.
        Returns:
        Java fault's throwable, or null if no Java fault is set.
        Since:
        11.1.1.4

      • setOpaqueData

        public TransportException setOpaqueData(Map<String,Object> data)
        Stores opaque (i.e. unspecified/unstructured) data from transport providers. A typical use case is when a TransportException is thrown on the request thread by an outbound transport endpoint of type XYZ, and this endpoint wants to pass along some provider-specific data that can be retrieved by the calling inbound endpoint, which also happens to be of type XYZ and knows how to interpret the data. Note: inbound transport must send the message to the transport manager with the transport options TransportOptions.Option.THROW_ON_ERROR
        Parameters:
        data - opaque data, a map of object keyed by string.
        Returns:
        updated transport exception instance
        Since:
        11.1.1.4

      • getOpaqueData

        public Map<String,Object> getOpaqueData()
        Get the opaque data. Se also setOpaqueData(java.util.Map<java.lang.String, java.lang.Object>). This method is not thread safe
        Returns:
        opaque (i.e. unspecified/unstructured) data from transport providers, may be null if none is set.
        Since:
        11.1.1.4