Enum OCFErrorCode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<OCFErrorCode>, ExceptionMessageSet

    public enum OCFErrorCode
    extends java.lang.Enum<OCFErrorCode>
    implements ExceptionMessageSet
    The OCF error code is used to define first failure data capture (FFDC) for errors that occur when working with OCF Connectors. It is used in conjunction with all OCF Exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:
    • HTTP Error Code for translating between REST and JAVA - Typically the numbers used are:
      • 500 - internal error
      • 400 - invalid parameters
      • 404 - not found
      • 409 - data conflict errors - eg item already defined
    • Error Message Id - to uniquely identify the message
    • Error Message Text - includes placeholder to allow additional values to be captured
    • SystemAction - describes the result of the error
    • UserAction - describes how a user should correct the error
    • Enum Constant Detail

      • NULL_CONNECTION

        public static final OCFErrorCode NULL_CONNECTION
      • UNNAMED_CONNECTION

        public static final OCFErrorCode UNNAMED_CONNECTION
      • NULL_CONNECTOR_TYPE

        public static final OCFErrorCode NULL_CONNECTOR_TYPE
      • NULL_CONNECTOR_PROVIDER

        public static final OCFErrorCode NULL_CONNECTOR_PROVIDER
      • UNKNOWN_CONNECTOR_PROVIDER

        public static final OCFErrorCode UNKNOWN_CONNECTOR_PROVIDER
      • NOT_CONNECTOR_PROVIDER

        public static final OCFErrorCode NOT_CONNECTOR_PROVIDER
      • INVALID_CONNECTOR_PROVIDER

        public static final OCFErrorCode INVALID_CONNECTOR_PROVIDER
      • NULL_ENDPOINT_IN_CONNECTION

        public static final OCFErrorCode NULL_ENDPOINT_IN_CONNECTION
      • MALFORMED_ENDPOINT

        public static final OCFErrorCode MALFORMED_ENDPOINT
      • NULL_PROPERTY_NAME

        public static final OCFErrorCode NULL_PROPERTY_NAME
      • INVALID_PROPERTY_NAMES

        public static final OCFErrorCode INVALID_PROPERTY_NAMES
      • NULL_SECURED_PROPERTY_NAME

        public static final OCFErrorCode NULL_SECURED_PROPERTY_NAME
      • NO_MORE_ELEMENTS

        public static final OCFErrorCode NO_MORE_ELEMENTS
      • NULL_CLASSIFICATION_NAME

        public static final OCFErrorCode NULL_CLASSIFICATION_NAME
      • NULL_TAG_NAME

        public static final OCFErrorCode NULL_TAG_NAME
      • UNABLE_TO_REMOVE

        public static final OCFErrorCode UNABLE_TO_REMOVE
      • INVALID_VIRTUAL_CONNECTION

        public static final OCFErrorCode INVALID_VIRTUAL_CONNECTION
      • ALREADY_COUNTER_NAME

        public static final OCFErrorCode ALREADY_COUNTER_NAME
      • ALREADY_PROPERTY_NAME

        public static final OCFErrorCode ALREADY_PROPERTY_NAME
      • ALREADY_TIMESTAMP_NAME

        public static final OCFErrorCode ALREADY_TIMESTAMP_NAME
      • UNKNOWN_ENDPOINT

        public static final OCFErrorCode UNKNOWN_ENDPOINT
      • PROPERTIES_NOT_AVAILABLE

        public static final OCFErrorCode PROPERTIES_NOT_AVAILABLE
      • UNKNOWN_SCHEMA_TYPE

        public static final OCFErrorCode UNKNOWN_SCHEMA_TYPE
      • CAUGHT_EXCEPTION

        public static final OCFErrorCode CAUGHT_EXCEPTION
      • CAUGHT_EXCEPTION_WITHMSG

        public static final OCFErrorCode CAUGHT_EXCEPTION_WITHMSG
      • NOT_IMPLEMENTED

        public static final OCFErrorCode NOT_IMPLEMENTED
      • UNKNOWN_ERROR

        public static final OCFErrorCode UNKNOWN_ERROR
      • INTERNAL_ERROR

        public static final OCFErrorCode INTERNAL_ERROR
      • NULL_CONNECTOR_CLASS

        public static final OCFErrorCode NULL_CONNECTOR_CLASS
      • UNKNOWN_CONNECTOR

        public static final OCFErrorCode UNKNOWN_CONNECTOR
      • NOT_CONNECTOR

        public static final OCFErrorCode NOT_CONNECTOR
      • INCOMPLETE_CONNECTOR

        public static final OCFErrorCode INCOMPLETE_CONNECTOR
      • INVALID_CONNECTOR

        public static final OCFErrorCode INVALID_CONNECTOR
      • NULL_CONNECTOR

        public static final OCFErrorCode NULL_CONNECTOR
      • NOT_VIRTUAL_CONNECTOR

        public static final OCFErrorCode NOT_VIRTUAL_CONNECTOR
    • Method Detail

      • values

        public static OCFErrorCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (OCFErrorCode c : OCFErrorCode.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static OCFErrorCode valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getHTTPErrorCode

        @Deprecated
        public int getHTTPErrorCode()
        Deprecated.
        Return the HTTP error code for this exception.
        Returns:
        int
      • getErrorMessageId

        @Deprecated
        public java.lang.String getErrorMessageId()
        Deprecated.
        Returns the unique identifier for the error message.
        Returns:
        errorMessageId
      • getFormattedErrorMessage

        @Deprecated
        public java.lang.String getFormattedErrorMessage​(java.lang.String... params)
        Deprecated.
        Returns the error message with the placeholders filled out with the supplied parameters.
        Parameters:
        params - strings that plug into the placeholders in the errorMessage
        Returns:
        errorMessage (formatted with supplied parameters)
      • getSystemAction

        @Deprecated
        public java.lang.String getSystemAction()
        Deprecated.
        Returns a description of the action taken by the system when the condition that caused this exception was detected.
        Returns:
        systemAction
      • getUserAction

        @Deprecated
        public java.lang.String getUserAction()
        Deprecated.
        Returns instructions of how to resolve the issue reported in this exception.
        Returns:
        userAction
      • getMessageDefinition

        public ExceptionMessageDefinition getMessageDefinition​(java.lang.String... params)
        Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.
        Specified by:
        getMessageDefinition in interface ExceptionMessageSet
        Parameters:
        params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.
        Returns:
        message definition object.
      • toString

        public java.lang.String toString()
        JSON-style toString
        Overrides:
        toString in class java.lang.Enum<OCFErrorCode>
        Returns:
        string of property names and values for this enum