org.odpi.openmetadata.accessservices.projectmanagement.ffdc.exceptions

Class UserNotAuthorizedException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.accessservices.projectmanagement.ffdc.exceptions.ProjectManagementCheckedExceptionBase

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

All Implemented Interfaces:

Serializable

public class UserNotAuthorizedException
extends ProjectManagementCheckedExceptionBase

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String userId) This is the typical constructor used for creating an exception.
UserNotAuthorizedException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String userId) This is the constructor used for creating an exception that resulted from a previous error.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
String	getUserId() Return the userId passed on the request.
int	hashCode() Return hash code for this object
String	toString() JSON-style toString

Methods inherited from class org.odpi.openmetadata.accessservices.projectmanagement.ffdc.exceptions.ProjectManagementCheckedExceptionBase

getErrorMessage, getReportedCaughtException, 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

UserNotAuthorizedException

public UserNotAuthorizedException(int httpCode,
                                  String className,
                                  String actionDescription,
                                  String errorMessage,
                                  String systemAction,
                                  String userAction,
                                  String userId)

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

UserNotAuthorizedException

public UserNotAuthorizedException(int httpCode,
                                  String className,
                                  String actionDescription,
                                  String errorMessage,
                                  String systemAction,
                                  String userAction,
                                  Throwable caughtError,
                                  String userId)

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.

Method Detail

getUserId

public String getUserId()

Return the userId passed on the request.

Returns:

string user id

toString

public String toString()

JSON-style toString

Overrides:

toString in class Throwable

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 ProjectManagementCheckedExceptionBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class ProjectManagementCheckedExceptionBase

Returns:

int hash code