org.kuali.rice.krad.exception

Class AuthorizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.kuali.rice.core.api.exception.KualiException

org.kuali.rice.krad.exception.AuthorizationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DocumentAuthorizationException, DocumentTypeAuthorizationException

public class AuthorizationException
extends KualiException

Represents an exception that is thrown when a given user is not authorized to take the given action on the given target type

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	action
protected Map<String,Object>	additionalDetails
protected String	targetType
protected String	userId

Constructor Summary

Constructors

Constructor and Description
AuthorizationException(String userId, String action, String targetType)
AuthorizationException(String userId, String action, String targetType, Map<String,Object> additionalDetails) Constructs a exception with a message from the passed in information.
AuthorizationException(String userId, String action, String targetType, String message, Map<String,Object> additionalDetails) Allows you to construct the exception message manually

Method Summary

Methods

Modifier and Type	Method and Description
String	getAction()
Map<String,Object>	getAdditionalDetails()
String	getErrorMessageKey() Deprecated.
String	getTargetType()
String	getUserId()

Methods inherited from class org.kuali.rice.core.api.exception.KualiException

isHideIncidentReport, setHideIncidentReport

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

userId

protected final String userId

action

protected final String action

targetType

protected final String targetType

additionalDetails

protected final Map<String,Object> additionalDetails

Constructor Detail

AuthorizationException

public AuthorizationException(String userId,
                      String action,
                      String targetType)

AuthorizationException

public AuthorizationException(String userId,
                      String action,
                      String targetType,
                      Map<String,Object> additionalDetails)

Constructs a exception with a message from the passed in information.

Parameters:

userId - the userid of the user who failed authorization

action - the action the user was trying to take

targetType - what the user was trying to take action on

additionalDetails - additional details about the authorization failure to be passed in and added to the exception message (ex: permission name, qualifiers, etc.)

AuthorizationException

public AuthorizationException(String userId,
                      String action,
                      String targetType,
                      String message,
                      Map<String,Object> additionalDetails)

Allows you to construct the exception message manually

Method Detail

getUserId

public String getUserId()

getAction

public String getAction()

getTargetType

public String getTargetType()

getAdditionalDetails

public Map<String,Object> getAdditionalDetails()

getErrorMessageKey

@Deprecated
public String getErrorMessageKey()

Deprecated.

Returns:

message key used by Struts to select the error message to be displayed