public class TransportException
extends java.lang.Exception
If set, the error code is usually one of:
TransportManager.TRANSPORT_ERROR_GENERIC
TransportManager.TRANSPORT_ERROR_CONNECTION
TransportManager.TRANSPORT_ERROR_APPLICATION
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>)
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
_errorCode
Optional error code.
|
protected Source |
_errorPayload
Deprecated.
|
Constructor and Description |
---|
TransportException()
Constructs a TransportException.
|
TransportException(CatalogMessage message) |
TransportException(CatalogMessage message, java.lang.Throwable cause) |
TransportException(java.lang.String msg)
Constructs a TransportException with the specified message text.
|
TransportException(java.lang.String message, Source errorPayload)
Deprecated.
|
TransportException(java.lang.String msg, java.lang.String errorCode)
Constructs a TransportException with the specified message text and specified error code
|
TransportException(java.lang.String message, java.lang.Throwable cause)
Constructs a TransportException with the specified detail message and cause.
|
TransportException(java.lang.String message, java.lang.Throwable cause, java.lang.String errorCode)
Constructs a TransportException with the specified detail message and cause and error code.
|
TransportException(java.lang.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).
|
TransportException(java.lang.Throwable cause, java.lang.String errorCode)
Constructs a TransportException with the specified cause and error code.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getErrorCode() |
Source |
getErrorPayload()
Deprecated.
|
java.lang.Throwable |
getJavaFault()
Get the java fault metadata.
|
java.util.Map<java.lang.String,java.lang.Object> |
getOpaqueData()
Get the opaque data.
|
static TransportException |
newInstance(java.lang.Throwable cause)
Most transport SDK API signatures declare only TransportException to be thrown.
|
TransportException |
setJavaFault(java.lang.Throwable fault)
When throwing an exception on the request thread, instruct the pipeline to add a throwable to the $fault variable.
|
TransportException |
setOpaqueData(java.util.Map<java.lang.String,java.lang.Object> data)
Stores opaque (i.e.
|
@Deprecated protected transient Source _errorPayload
protected java.lang.String _errorCode
TransportManager
public TransportException()
public TransportException(java.lang.String msg)
msg
- Message text.public TransportException(java.lang.String msg, java.lang.String errorCode)
msg
- Message text.errorCode
- error codepublic TransportException(java.lang.String message, java.lang.Throwable cause)
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.)public TransportException(java.lang.String message, java.lang.Throwable cause, java.lang.String errorCode)
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 codepublic TransportException(java.lang.Throwable cause)
PrivilegedActionException
).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.)public TransportException(java.lang.Throwable cause, java.lang.String errorCode)
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 codepublic TransportException(java.lang.String message, Source errorPayload)
message
- error messageerrorPayload
- error payload sourcepublic TransportException(CatalogMessage message)
public TransportException(CatalogMessage message, java.lang.Throwable cause)
@Deprecated public Source getErrorPayload()
public java.lang.String getErrorCode()
public static TransportException newInstance(java.lang.Throwable cause)
void someAPI() throws TransportException { try { .... } catch (Exception e) { throw TransportException.newInstance(e); } }
cause
- original cause of the exceptionpublic TransportException setJavaFault(java.lang.Throwable fault)
BindingTypeInfo.MessageTypeEnum.JAVA
. This method is not thread-safe.fault
- throwablepublic java.lang.Throwable getJavaFault()
setJavaFault(java.lang.Throwable)
This method is not thread safe.public TransportException setOpaqueData(java.util.Map<java.lang.String,java.lang.Object> data)
TransportOptions.Option.THROW_ON_ERROR
data
- opaque data, a map of object keyed by string.public java.util.Map<java.lang.String,java.lang.Object> getOpaqueData()
setOpaqueData(java.util.Map<java.lang.String, java.lang.Object>)
. This method is not thread safe