Class UserNotAuthorizedException
java.lang.Object
java.lang.Throwable
java.lang.Exception
org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
org.odpi.openmetadata.commonservices.ffdc.exceptions.UserNotAuthorizedException
- All Implemented Interfaces:
Serializable
The UserNotAuthorizedException is thrown by the OMAG Service when a userId passed on a request is not
authorized to perform the requested action.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionUserNotAuthorizedException
(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, String userId, Map<String, Object> relatedProperties) This is the constructor used when receiving an exception from a remote server.UserNotAuthorizedException
(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId) Deprecated.UserNotAuthorizedException
(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId, Map<String, Object> relatedProperties) Deprecated.UserNotAuthorizedException
(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId) Deprecated.UserNotAuthorizedException
(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId, Map<String, Object> relatedProperties) Deprecated.UserNotAuthorizedException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String userId) This is the typical constructor used for creating an UserNotAuthorizedException.UserNotAuthorizedException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String userId, Map<String, Object> relatedProperties) This is the typical constructor used for creating an UserNotAuthorizedException.UserNotAuthorizedException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String userId) This is the constructor used for creating an UserNotAuthorizedException when an unexpected error has been caught.UserNotAuthorizedException
(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String userId, Map<String, Object> relatedProperties) This is the constructor used for creating an UserNotAuthorizedException when an unexpected error has been caught.This is the copy/clone constructor used for creating an exception. -
Method Summary
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
equals, getUserId, hashCode
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
-
UserNotAuthorizedException
public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String userId) This is the typical constructor used for creating an UserNotAuthorizedException.- Parameters:
messageDefinition
- content of the messageclassName
- name of class reporting erroractionDescription
- description of function it was performing when error detecteduserId
- offending userId
-
UserNotAuthorizedException
public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String userId, Map<String, Object> relatedProperties) This is the typical constructor used for creating an UserNotAuthorizedException. 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 detecteduserId
- offending userIdrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
UserNotAuthorizedException
public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String userId) This is the constructor used for creating an UserNotAuthorizedException 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 exceptionuserId
- offending userId
-
UserNotAuthorizedException
public UserNotAuthorizedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Throwable caughtError, String userId, Map<String, Object> relatedProperties) This is the constructor used for creating an UserNotAuthorizedException 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 exceptionuserId
- offending userIdrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
UserNotAuthorizedException
public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String errorMessageId, String[] errorMessageParameters, String systemAction, String userAction, String caughtErrorClassName, String userId, 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 exceptionuserId
- failing userIdrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
UserNotAuthorizedException
@Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId) 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 erroruserId
- offending userId
-
UserNotAuthorizedException
@Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId, 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 erroruserId
- offending userIdrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
UserNotAuthorizedException
@Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId) 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.userId
- calling user
-
UserNotAuthorizedException
@Deprecated public UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId, 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.userId
- calling userrelatedProperties
- arbitrary properties that may help with diagnosing the problem.
-
UserNotAuthorizedException
This is the copy/clone constructor used for creating an exception.- Parameters:
template
- object to copy
-
-
Method Details
-
toString
JSON-style toString- Overrides:
toString
in classUserNotAuthorizedException
- Returns:
- string of property names and values for this enum
-