Package org.odpi.openmetadata.frameworks.connectors.ffdc

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:

Serializable

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, 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 for creating a PropertyServerException.
PropertyServerException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, 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, String className, String actionDescription, Throwable caughtError, Map<String,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, String className, String actionDescription, Map<String,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

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 Detail

PropertyServerException

public PropertyServerException(ExceptionMessageDefinition messageDefinition,
                               String className,
                               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 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 for creating a PropertyServerException. It captures the essential details about the error, where it occurred and how to fix it.

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.

PropertyServerException

public PropertyServerException(ExceptionMessageDefinition messageDefinition,
                               String className,
                               String actionDescription,
                               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 message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - the exception/error that caused this exception to be raised

PropertyServerException

public PropertyServerException(ExceptionMessageDefinition messageDefinition,
                               String className,
                               String actionDescription,
                               Throwable caughtError,
                               Map<String,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 message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - the exception/error that caused this exception to be raised

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(OCFCheckedExceptionBase template)

This is the copy/clone constructor used for creating an exception.

Parameters:

template - object to copy

Method Detail

toString

public String toString()

JSON-style toString

Overrides:

toString in class OCFCheckedExceptionBase

Returns:

string of property names and values for this enum