Package com.apama.iaf.plugin

Class CodecException

  • All Implemented Interfaces:
    java.io.Serializable
    public class CodecException
extends java.lang.Exception
    CodecException is the exception class thrown by a Java IAF Codec plugin.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int BADPROPERTIES
      Codec was passed an invalid property set
      static int DECODINGFAILURE
      Couldn't decode an incoming customer event
      static int ENCODINGFAILURE
      Couldn't encode an incoming normalised event
      static int INTERNALERROR
      Some unspecified internal error occurred
      static int MAPPINGFAILURE
      Trouble sending decoded event to Semantic Mapper
      static int OK
      Everything is fine
      static int TRANSPORTFAILURE
      Trouble sending encoded event to transport

    • Constructor Summary

      Constructors 
      Constructor Description
      CodecException​(java.lang.String message)
      Constructs a CodecException from a string message describing the error, and assumes an error code of INTERNALERROR.
      CodecException​(java.lang.String message, int code)
      Constructs a CodecException from a string message describing the error and a numeric code representing the class of error.
      CodecException​(java.lang.String message, java.lang.Throwable cause)
      Constructs a CodecException from a string message describing the error, and an exception object that is the cause of the error.
      CodecException​(java.lang.String message, java.lang.Throwable cause, int code)
      Constructs a CodecException 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

      • ENCODINGFAILURE

        public static final int ENCODINGFAILURE
        Couldn't encode an incoming normalised event
        See Also:
        Constant Field Values

      • DECODINGFAILURE

        public static final int DECODINGFAILURE
        Couldn't decode an incoming customer event
        See Also:
        Constant Field Values

      • TRANSPORTFAILURE

        public static final int TRANSPORTFAILURE
        Trouble sending encoded event to transport
        See Also:
        Constant Field Values

      • MAPPINGFAILURE

        public static final int MAPPINGFAILURE
        Trouble sending decoded event to Semantic Mapper
        See Also:
        Constant Field Values

      • BADPROPERTIES

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

    • Constructor Detail

      • CodecException

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

      • CodecException

        public CodecException​(java.lang.String message,
                      int code)
        Constructs a CodecException 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 CodecException error codes.

      • CodecException

        public CodecException​(java.lang.String message,
                      java.lang.Throwable cause)
        Constructs a CodecException from a string message describing the error, and an exception object that is the cause of the error. It assumes an error code of INTERNALERROR.
        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.

      • CodecException

        public CodecException​(java.lang.String message,
                      java.lang.Throwable cause,
                      int code)
        Constructs a CodecException 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 CodecException error codes.

    • Method Detail

      • getErrorCode

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