Class PropertyServerException
- java.lang.Object
-
- java.lang.Throwable
-
- java.lang.Exception
-
- org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
-
- org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
-
- All Implemented Interfaces:
java.io.Serializable
- Direct Known Subclasses:
PropertyServerException
public class PropertyServerException extends OCFCheckedExceptionBase
PropertyServerException provides a checked exception for reporting errors when connecting to a metadata repository to retrieve properties about the connection and/or connector. It may be a configuration error or temporary outage. The parameters captured by the constructors pinpoint the type an cause of the error.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description 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.PropertyServerException(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription)
This is the typical constructor for creating a PropertyServerException.PropertyServerException(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription, java.lang.Throwable caughtError)
This constructor is used when an unexpected exception has been caught that needs to be wrapped in a PropertyServerException in order to add the essential details about the error, where it occurred and how to fix it.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 constructor is used when an unexpected exception has been caught that needs to be wrapped in a PropertyServerException in order to add the essential details about the error, where it occurred and how to fix it.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 for creating a PropertyServerException.PropertyServerException(OCFCheckedExceptionBase template)
This is the copy/clone constructor used for creating an exception.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
toString()
JSON-style toString-
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
equals, getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName, hashCode
-
-
-
-
Constructor Detail
-
PropertyServerException
public PropertyServerException(ExceptionMessageDefinition messageDefinition, java.lang.String className, java.lang.String actionDescription)
This is the typical constructor for creating a PropertyServerException. It captures the essential details about the error, where it occurred and how to fix it.- Parameters:
messageDefinition
- content of messageclassName
- name of class reporting erroractionDescription
- 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 for creating a PropertyServerException. It captures the essential details about the error, where it occurred and how to fix it.- Parameters:
messageDefinition
- content of messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedrelatedProperties
- 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 constructor is used when an unexpected exception has been caught that needs to be wrapped in a PropertyServerException in order to add the essential details about the error, where it occurred and how to fix it.- Parameters:
messageDefinition
- content of messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedcaughtError
- the exception/error that caused this exception to be raised
-
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 constructor is used when an unexpected exception has been caught that needs to be wrapped in a PropertyServerException in order to add the essential details about the error, where it occurred and how to fix it.- Parameters:
messageDefinition
- content of messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedcaughtError
- the exception/error that caused this exception to be raisedrelatedProperties
- 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 callclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectederrorMessage
- description of errorerrorMessageId
- unique identifier for the messageerrorMessageParameters
- parameters that were inserted in the messagesystemAction
- actions of the system as a result of the erroruserAction
- instructions for correcting the errorcaughtErrorClassName
- previous error causing this exceptionrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
PropertyServerException
public PropertyServerException(OCFCheckedExceptionBase 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 classOCFCheckedExceptionBase
- Returns:
- string of property names and values for this enum
-
-