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
org.odpi.openmetadata.commonservices.ffdc.exceptions.InvalidParameterException
- All Implemented Interfaces:
Serializable
The InvalidParameterException is thrown by the OMAG Service when a parameter is null or an invalid value.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionInvalidParameterException
(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, ConnectionCheckedException template, String parameterName) This is the copy/clone constructor used for creating an exception.InvalidParameterException
(String errorMessage, InvalidParameterException template) 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 InvalidParameterException.InvalidParameterException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String parameterName, Map<String, Object> relatedProperties) This is the typical constructor used for creating an InvalidParameterException.InvalidParameterException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String parameterName) This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught.InvalidParameterException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String parameterName, Map<String, Object> relatedProperties) This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught. -
Method Summary
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
equals, getParameterName, hashCode, 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
-
Constructor Details
-
InvalidParameterException
public InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String parameterName) This is the typical constructor used for creating an InvalidParameterException.- Parameters:
messageDefinition
- content of the messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedparameterName
- 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 InvalidParameterException. The properties allow additional information to be associated with the exception.- Parameters:
messageDefinition
- content of the messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedparameterName
- name of the invalid parameter if knownrelatedProperties
- 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 InvalidParameterException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.- Parameters:
messageDefinition
- content of the messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedcaughtError
- previous error causing this exceptionparameterName
- 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 InvalidParameterException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.- Parameters:
messageDefinition
- content of the messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectedcaughtError
- previous error causing this exceptionparameterName
- name of the invalid parameter if knownrelatedProperties
- 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 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 exceptionparameterName
- name of the invalid parameter if knownrelatedProperties
- 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, 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 callclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectederrorMessage
- description of errorsystemAction
- actions of the system as a result of the erroruserAction
- instructions for correcting the errorparameterName
- 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 callclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectederrorMessage
- description of errorsystemAction
- actions of the system as a result of the erroruserAction
- instructions for correcting the errorparameterName
- name of the invalid parameter if knownrelatedProperties
- 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 callclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectederrorMessage
- description of errorsystemAction
- actions of the system as a result of the erroruserAction
- instructions for correcting the errorcaughtError
- 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 callclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detectederrorMessage
- description of errorsystemAction
- actions of the system as a result of the erroruserAction
- instructions for correcting the errorcaughtError
- the error that resulted in this exception.parameterName
- name of the invalid parameter if knownrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
InvalidParameterException
This is the copy/clone constructor used for creating an exception.- Parameters:
errorMessage
- associated error messagetemplate
- object to copy
-
InvalidParameterException
public InvalidParameterException(String errorMessage, ConnectionCheckedException template, String parameterName) This is the copy/clone constructor used for creating an exception.- Parameters:
errorMessage
- associated error messagetemplate
- object to copyparameterName
- name of parameter in error
-