Package com.apama.iaf.plugin

Class TransportException

  • All Implemented Interfaces:
    java.io.Serializable
    public class TransportException
extends java.lang.Exception
    TransportException is the exception class thrown by aJava IAF Transport plugin.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BADPROPERTIES
      Transport was passed an invalid property set
      static int DECODINGFAILURE
      Trouble sending transport event to decoder
      static int INTERNALERROR
      Some unspecified internal error occurred
      static int OK
      Everything is fine
      static int TRANSPORTFAILURE
      Trouble reading/writing the external transport

    • Constructor Summary

      Constructors 
      Constructor Description
      TransportException​(java.lang.String message)
      Constructs a TransportException from a string message describing the error, and assumes an error code of TRANSPORTFAILURE.
      TransportException​(java.lang.String message, int code)
      Constructs a TransportException from a string message describing the error and a numeric code representing the class of error.
      TransportException​(java.lang.String message, java.lang.Throwable cause)
      Constructs a TransportException from a string message describing the error, and an exception object that is the cause of the error.
      TransportException​(java.lang.String message, java.lang.Throwable cause, int code)
      Constructs a TransportException from a string message describing the error, a numeric code representing the class of error and an exception object that is the cause of the error.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getErrorCode()
      Returns the integer code representing the type of transport error that occurred.

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • INTERNALERROR

        public static final int INTERNALERROR
        Some unspecified internal error occurred
        See Also:
        Constant Field Values

      • TRANSPORTFAILURE

        public static final int TRANSPORTFAILURE
        Trouble reading/writing the external transport
        See Also:
        Constant Field Values

      • DECODINGFAILURE

        public static final int DECODINGFAILURE
        Trouble sending transport event to decoder
        See Also:
        Constant Field Values

      • BADPROPERTIES

        public static final int BADPROPERTIES
        Transport was passed an invalid property set
        See Also:
        Constant Field Values

    • Constructor Detail

      • TransportException

        public TransportException​(java.lang.String message)
        Constructs a TransportException from a string message describing the error, and assumes an error code of TRANSPORTFAILURE.
        Parameters:
        message - The cause of the error.

      • TransportException

        public TransportException​(java.lang.String message,
                          int code)
        Constructs a TransportException from a string message describing the error and a numeric code representing the class of error.
        Parameters:
        message - The cause of the error.
        code - One of the TransportException error codes.

      • TransportException

        public TransportException​(java.lang.String message,
                          java.lang.Throwable cause)
        Constructs a TransportException from a string message describing the error, and an exception object that is the cause of the error. It assumes an error code of TRANSPORTFAILURE.
        Parameters:
        message - The cause of the error. This message will be suffixed with the message of the 'cause' exception.
        cause - The exception object that caused the error.

      • TransportException

        public TransportException​(java.lang.String message,
                          java.lang.Throwable cause,
                          int code)
        Constructs a TransportException from a string message describing the error, a numeric code representing the class of error and an exception object that is the cause of the error.
        Parameters:
        message - The cause of the error. This message will be suffixed with the message of the 'cause' exception.
        cause - The exception object that caused the error.
        code - One of the TransportException error codes.

    • Method Detail

      • getErrorCode

        public int getErrorCode()
        Returns the integer code representing the type of transport error that occurred.
        Returns:
        One of the TransportException error codes.