Package org.odpi.openmetadata.accessservices.subjectarea.ffdc.exceptions

Class UserNotAuthorizedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

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

org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

org.odpi.openmetadata.accessservices.subjectarea.ffdc.exceptions.SubjectAreaCheckedException

org.odpi.openmetadata.accessservices.subjectarea.ffdc.exceptions.UserNotAuthorizedException

All Implemented Interfaces:

Serializable

public class UserNotAuthorizedException
extends SubjectAreaCheckedException

The UserNotAuthorizedException is thrown by the Subject Area OMAS when a userId passed on a request is not authorized to perform the requested action.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
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, Throwable caughtError, String userId)	This is the constructor used for creating an UserNotAuthorizedException when an unexpected error has been caught.

Method Summary

Modifier and Type	Method	Description
String	getUserId()

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

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

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 message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

userId - userId associated with this Exception

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 message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

userId - userId associated with this Exception

Method Detail

getUserId

public String getUserId()