Class ConnectionCheckedException

  • All Implemented Interfaces:
    java.io.Serializable

    public class ConnectionCheckedException
    extends OCFCheckedExceptionBase
    ConnectionCheckedException provides a checked exception for reporting errors found in connection objects. Typically these errors are configuration errors that can be fixed by an administrator or power user. The connection object has a complex structure and the aim of this exception, in conjunction with OCFErrorCode, is to identify exactly what is wrong with the contents of the connection object and the consequences of this error.
    See Also:
    Serialized Form
    • Constructor Detail

      • ConnectionCheckedException

        public ConnectionCheckedException​(ExceptionMessageDefinition messageDefinition,
                                          java.lang.String className,
                                          java.lang.String actionDescription)
        This is the typical constructor used for creating an exception.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
      • ConnectionCheckedException

        public ConnectionCheckedException​(ExceptionMessageDefinition messageDefinition,
                                          java.lang.String className,
                                          java.lang.String actionDescription,
                                          java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        This is the typical constructor used for creating an exception.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • ConnectionCheckedException

        public ConnectionCheckedException​(ExceptionMessageDefinition messageDefinition,
                                          java.lang.String className,
                                          java.lang.String actionDescription,
                                          java.lang.Throwable caughtError)
        This is the constructor used for creating an exception that resulted from a previous error.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - the error that resulted in this exception.
      • ConnectionCheckedException

        public ConnectionCheckedException​(ExceptionMessageDefinition messageDefinition,
                                          java.lang.String className,
                                          java.lang.String actionDescription,
                                          java.lang.Throwable caughtError,
                                          java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        This is the constructor used for creating an exception that resulted from a previous error.
        Parameters:
        messageDefinition - content of message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - the error that resulted in this exception.
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • ConnectionCheckedException

        public ConnectionCheckedException​(int httpCode,
                                          java.lang.String className,
                                          java.lang.String actionDescription,
                                          java.lang.String errorMessage,
                                          java.lang.String errorMessageId,
                                          java.lang.String[] errorMessageParameters,
                                          java.lang.String systemAction,
                                          java.lang.String userAction,
                                          java.lang.String caughtErrorClassName,
                                          java.util.Map<java.lang.String,​java.lang.Object> relatedProperties)
        This is the constructor used when receiving an exception from a remote server. The values are stored directly in the response object and are passed explicitly to the new exception. Notice that the technical aspects of the exception - such as class name creating the exception are local values so that the implementation of the server is not exposed.
        Parameters:
        httpCode - http response code to use if this exception flows over a REST call
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        errorMessageId - unique identifier for the message
        errorMessageParameters - parameters that were inserted in the message
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        caughtErrorClassName - previous error causing this exception
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • ConnectionCheckedException

        public ConnectionCheckedException​(java.lang.String errorMessage,
                                          ConnectionCheckedException template)
        This is the copy/clone constructor used for creating an exception.
        Parameters:
        errorMessage - associated message
        template - object to copy
      • ConnectionCheckedException

        @Deprecated
        public ConnectionCheckedException​(int httpCode,
                                          java.lang.String className,
                                          java.lang.String actionDescription,
                                          java.lang.String errorMessage,
                                          java.lang.String systemAction,
                                          java.lang.String userAction)
        Deprecated.
        This is the typical constructor for creating a ConnectionCheckedException. It captures the essential details about the error, where it occurred and how to fix it.
        Parameters:
        httpCode - code to use across a REST interface
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
      • ConnectionCheckedException

        @Deprecated
        public ConnectionCheckedException​(int httpCode,
                                          java.lang.String className,
                                          java.lang.String actionDescription,
                                          java.lang.String errorMessage,
                                          java.lang.String systemAction,
                                          java.lang.String userAction,
                                          java.lang.Throwable caughtError)
        Deprecated.
        This constructor is used when an unexpected exception has been caught that needs to be wrapped in a ConnectionCheckedException in order to add the essential details about the error, where it occurred and how to fix it.
        Parameters:
        httpCode - code to use across a REST interface
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        errorMessage - description of error
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        caughtError - the exception/error that caused this exception to be raised