Package org.operaton.bpm.engine

Class AuthorizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.operaton.bpm.engine.ProcessEngineException

org.operaton.bpm.engine.AuthorizationException

All Implemented Interfaces:

Serializable

public class AuthorizationException
extends ProcessEngineException

Exception thrown by the process engine in case a user tries to interact with a resource in an unauthorized way.

The exception contains a list of Missing authorizations. The List is a disjunction i.e. a user should have any of the authorization for the engine to continue the execution beyond the point where it failed.

Author:

Daniel Meyer

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<MissingAuthorization>	missingAuthorizations
protected String	permissionName	Deprecated.
protected String	resourceId	Deprecated.
protected String	resourceType	Deprecated.
protected final String	userId

Fields inherited from class org.operaton.bpm.engine.ProcessEngineException

code

Constructor Summary

Constructors

Constructor	Description
AuthorizationException(String message)
AuthorizationException(String userId, String permissionName, String resourceType, String resourceId)
AuthorizationException(String userId, List<MissingAuthorization> info)
AuthorizationException(String userId, MissingAuthorization exceptionInfo)

Method Summary

Modifier and Type	Method	Description
static String	generateMissingAuthorizationsList(List<MissingAuthorization> missingAuthorizations)	Generate a String containing a list of missing authorizations.
List<MissingAuthorization>	getMissingAuthorizations()
String	getResourceId()	Deprecated, for removal: This API element is subject to removal in a future version. Use getMissingAuthorizations() instead to get the id of the resource of the MissingAuthorization(s).
String	getResourceType()	Deprecated, for removal: This API element is subject to removal in a future version. Use getMissingAuthorizations() instead to get the type of the resource of the MissingAuthorization(s).
String	getUserId()
String	getViolatedPermissionName()	Deprecated, for removal: This API element is subject to removal in a future version. Use getMissingAuthorizations() instead to get the violated permission name of the MissingAuthorization(s).

Methods inherited from class org.operaton.bpm.engine.ProcessEngineException

getCode, setCode

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 Details

userId

protected final String userId

missingAuthorizations

protected final List<MissingAuthorization> missingAuthorizations

resourceType

@Deprecated(since="1.0")
protected String resourceType

Deprecated.

permissionName

@Deprecated(since="1.0")
protected String permissionName

Deprecated.

resourceId

@Deprecated(since="1.0")
protected String resourceId

Deprecated.

Constructor Details

AuthorizationException

public AuthorizationException(String message)

AuthorizationException

public AuthorizationException(String userId,
 String permissionName,
 String resourceType,
 String resourceId)

AuthorizationException

public AuthorizationException(String userId,
 MissingAuthorization exceptionInfo)

AuthorizationException

public AuthorizationException(String userId,
 List<MissingAuthorization> info)

Method Details

getResourceType

@Deprecated(forRemoval=true,
            since="1.0")
public String getResourceType()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMissingAuthorizations() instead to get the type of the resource of the MissingAuthorization(s).

Returns:

the type of the resource if there is only one MissingAuthorization, null otherwise.

getViolatedPermissionName

@Deprecated(forRemoval=true,
            since="1.0")
public String getViolatedPermissionName()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMissingAuthorizations() instead to get the violated permission name of the MissingAuthorization(s).

Returns:

the type of the violated permission name if there is only one MissingAuthorization, null otherwise.

getUserId

public String getUserId()

Returns:

id of the user in which context the request was made and who misses authorizations to perform it successfully.

getResourceId

@Deprecated(forRemoval=true,
            since="1.0")
public String getResourceId()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getMissingAuthorizations() instead to get the id of the resource of the MissingAuthorization(s).

Returns:

the id of the resource if there is only one MissingAuthorization, null otherwise.

getMissingAuthorizations

public List<MissingAuthorization> getMissingAuthorizations()

Returns:

Disjunctive list of MissingAuthorization from which a user needs to have at least one for the authorization to pass

generateMissingAuthorizationsList

public static String generateMissingAuthorizationsList(List<MissingAuthorization> missingAuthorizations)

Generate a String containing a list of missing authorizations.

Parameters:

missingAuthorizations -