Package com.apama

Class EngineException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    InterruptedEngineException
    public class EngineException
extends com.apama.util.CompoundException

    An EngineException is thrown by various methods of classes in the Engine Client SDK if any problems are encountered. It is simply a subclass of CompoundException with a different name to enable finer grained exception handling.

    The subclass of this exception, InterruptedEngineException, signifies that the calling thread has been interrupted; it does not mean a communication error has occurred.

    The EngineException provides (via the superclass) a mechanism to wrap any other exception (any subclass of Throwable) so that the API of the Engine CLient SDK can provide a simpler common interface.

    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      EngineException​(java.lang.String msg)
      Create a simple exception with the given message.
      EngineException​(java.lang.String msg, java.lang.String[] warnings)
      Create a simple exception with the given message.
      EngineException​(java.lang.String msg, java.lang.Throwable wrappedException)
      Create a compound exception with the given message and that references the given exception.
      EngineException​(java.lang.Throwable t)
      Create a compound exception that references the given exception.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.String[] getWarnings()
      Get an array of warnings which might have been returned along with the error.
      java.lang.Throwable getWrappedException()
      Deprecated.
      This method has been renamed to CompoundException.getCause() as part of an API review and may be deleted in a future release.

      • Methods inherited from class com.apama.util.CompoundException

        getCause, getNestedException, getRootCause, hasNestedException

      • Methods inherited from class java.lang.Throwable

        addSuppressed, fillInStackTrace, 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

    • Constructor Detail

      • EngineException

        public EngineException​(java.lang.String msg,
                       java.lang.String[] warnings)
        Create a simple exception with the given message.
        Parameters:
        msg - the message for the new exception.
        warnings - the array of warnings to be included in the exception

      • EngineException

        public EngineException​(java.lang.String msg)
        Create a simple exception with the given message.
        Parameters:
        msg - the message for the new exception.

      • EngineException

        public EngineException​(java.lang.Throwable t)
        Create a compound exception that references the given exception.
        Parameters:
        t - the exception to be wrapped.

      • EngineException

        public EngineException​(java.lang.String msg,
                       java.lang.Throwable wrappedException)
        Create a compound exception with the given message and that references the given exception.
        Parameters:
        msg - the message for the new exception.
        wrappedException - the exception to be wrapped.

    • Method Detail

      • getWarnings

        public java.lang.String[] getWarnings()
        Get an array of warnings which might have been returned along with the error. Used by the injectMonitorScript(), injectCDP() and injectJava() methods on EngineManagement and the various inject methods on the EngineClientBean.

      • getWrappedException

        @Deprecated
public java.lang.Throwable getWrappedException()
        Deprecated.
        This method has been renamed to CompoundException.getCause() as part of an API review and may be deleted in a future release.
        See Also:
        CompoundException.getCause()