Class PropertyServerException

  • All Implemented Interfaces:
    java.io.Serializable

    public class PropertyServerException
    extends PropertyServerException
    The PropertyServerException is thrown by the OMAG Service when it is not able to communicate with the property server.
    See Also:
    Serialized Form
    • Constructor Detail

      • PropertyServerException

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

        public PropertyServerException​(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. The properties allow additional information to be associated with the exception.
        Parameters:
        messageDefinition - content of the 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.
      • PropertyServerException

        public PropertyServerException​(ExceptionMessageDefinition messageDefinition,
                                       java.lang.String className,
                                       java.lang.String actionDescription,
                                       java.lang.Throwable caughtError)
        This is the constructor used for creating an exception when an unexpected error has been caught. The properties allow additional information to be associated with the exception.
        Parameters:
        messageDefinition - content of the message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - previous error causing this exception
      • PropertyServerException

        public PropertyServerException​(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 when an unexpected error has been caught. The properties allow additional information to be associated with the exception.
        Parameters:
        messageDefinition - content of the message
        className - name of class reporting error
        actionDescription - description of function it was performing when error detected
        caughtError - previous error causing this exception
        relatedProperties - arbitrary properties that may help with diagnosing the problem.
      • PropertyServerException

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

        public PropertyServerException​(PropertyServerException template)
        This is the copy/clone constructor used for creating an exception.
        Parameters:
        template - object to copy
    • Method Detail

      • toString

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