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

Class InvalidParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

All Implemented Interfaces:

Serializable

public class InvalidParameterException
extends OCFCheckedExceptionBase

The InvalidParameterException is thrown by the connector when a parameter is null or an invalid value.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
String	getParameterName()	Return the invalid parameter's name, if known.
int	hashCode()	Return hash code for this object
String	toString()	JSON-style toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

getErrorMessage, getRelatedProperties, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName

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

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 String parameterName)

This is the typical constructor used for creating an exception.

Parameters:

messageDefinition - content of message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

parameterName - name of the invalid parameter if known

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 String parameterName,
                                 Map<String,Object> relatedProperties)

This is the typical constructor used for creating an exception.

Parameters:

messageDefinition - content of message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Throwable caughtError,
                                 String parameterName)

This is the constructor used for creating an exception that resulted from a previous error.

Parameters:

messageDefinition - content of message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - the error that resulted in this exception.

parameterName - name of the invalid parameter if known

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
                                 String className,
                                 String actionDescription,
                                 Throwable caughtError,
                                 String parameterName,
                                 Map<String,Object> relatedProperties)

This is the constructor used for creating an exception that resulted from a previous error.

Parameters:

messageDefinition - content of message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - the error that resulted in this exception.

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

InvalidParameterException

public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String errorMessageId,
                                 String[] errorMessageParameters,
                                 String systemAction,
                                 String userAction,
                                 String caughtErrorClassName,
                                 String parameterName,
                                 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

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

InvalidParameterException

public InvalidParameterException(String errorMessage,
                                 InvalidParameterException template)

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

Parameters:

errorMessage - message for the exception

template - object to copy

InvalidParameterException

public InvalidParameterException(InvalidParameterException template)

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

Parameters:

template - object to copy

InvalidParameterException

public InvalidParameterException(String errorMessage,
                                 OCFCheckedExceptionBase template,
                                 String parameterName)

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

Parameters:

errorMessage - message for the exception

template - object to copy

parameterName - name of invalid parameter

InvalidParameterException

public InvalidParameterException(OCFCheckedExceptionBase template,
                                 String parameterName)

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

Parameters:

template - object to copy

parameterName - name of invalid parameter

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 String parameterName)

Deprecated.

This is the typical constructor used for creating an exception.

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

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

parameterName - name of the invalid parameter if known

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 String parameterName,
                                 Map<String,Object> relatedProperties)

Deprecated.

This is the typical constructor used for creating an exception.

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

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 Throwable caughtError,
                                 String parameterName)

Deprecated.

This is the constructor used for creating an exception that resulted from a previous error.

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

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtError - the error that resulted in this exception.

parameterName - name of the invalid parameter if known

InvalidParameterException

@Deprecated
public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 Throwable caughtError,
                                 String parameterName,
                                 Map<String,Object> relatedProperties)

Deprecated.

This is the constructor used for creating an exception that resulted from a previous error.

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

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtError - the error that resulted in this exception.

parameterName - name of the invalid parameter if known

relatedProperties - arbitrary properties that may help with diagnosing the problem.

Method Detail

getParameterName

public String getParameterName()

Return the invalid parameter's name, if known.

Returns:

string name

toString

public String toString()

JSON-style toString

Overrides:

toString in class OCFCheckedExceptionBase

Returns:

string of property names and values for this enum

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class OCFCheckedExceptionBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class OCFCheckedExceptionBase

Returns:

int hash code