Package org.odpi.openmetadata.commonservices.ffdc.exceptions

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

org.odpi.openmetadata.commonservices.ffdc.exceptions.PropertyServerException

All Implemented Interfaces:

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 Summary

Constructors

Constructor	Description
PropertyServerException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, Map<String,Object> relatedProperties)	This is the constructor used when receiving an exception from a remote server.
PropertyServerException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription)	This is the typical constructor used for creating an exception.
PropertyServerException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError)	This is the constructor used for creating an exception when an unexpected error has been caught.
PropertyServerException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, Map<String,Object> relatedProperties)	This is the constructor used for creating an exception when an unexpected error has been caught.
PropertyServerException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties)	This is the typical constructor used for creating an exception.
PropertyServerException(PropertyServerException template)	This is the copy/clone constructor used for creating an exception.

Method Summary

Modifier and Type	Method	Description
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

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PropertyServerException

public PropertyServerException(ExceptionMessageDefinition messageDefinition,
 String className,
 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,
 String className,
 String actionDescription,
 Map<String,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,
 String className,
 String actionDescription,
 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,
 String className,
 String actionDescription,
 Throwable caughtError,
 Map<String,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,
 String className,
 String actionDescription,
 String errorMessage,
 String errorMessageId,
 String[] errorMessageParameters,
 String systemAction,
 String userAction,
 String caughtErrorClassName,
 Map<String,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 Details

toString

public String toString()

JSON-style toString

Overrides:

toString in class PropertyServerException

Returns:

string of property names and values for this enum