Class ConnectorCheckedException

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    DiscoveryServiceException, GovernanceServiceException

    public class ConnectorCheckedException
    extends OCFCheckedExceptionBase
    ConnectorCheckedException provides a checked exception for reporting errors found when using OCF connectors. Typically these errors are either configuration or operational errors that can be fixed by an administrator or power user. However, there may be the odd bug that surfaces here. The OCFErrorCode can be used with this exception to populate it with standard messages. Otherwise messages defined uniquely for a ConnectorProvider/Connector implementation can be used. The aim is to be able to uniquely identify the cause and remedy for the error.
    See Also:
    Serialized Form
    • Constructor Detail

      • ConnectorCheckedException

        public ConnectorCheckedException​(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
      • ConnectorCheckedException

        public ConnectorCheckedException​(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.
      • ConnectorCheckedException

        public ConnectorCheckedException​(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.
      • ConnectorCheckedException

        public ConnectorCheckedException​(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.
      • ConnectorCheckedException

        public ConnectorCheckedException​(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.
      • ConnectorCheckedException

        @Deprecated
        public ConnectorCheckedException​(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 used for creating a ConnectorCheckedException.
        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
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
      • ConnectorCheckedException

        @Deprecated
        public ConnectorCheckedException​(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 is the constructor used for creating a ConnectorCheckedException in response to a previous exception.
        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
        systemAction - actions of the system as a result of the error
        userAction - instructions for correcting the error
        caughtError - the error that resulted in this exception.
      • ConnectorCheckedException

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

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