org.camunda.bpm.engine.impl

Class AuthorizationServiceImpl

java.lang.Object

org.camunda.bpm.engine.impl.ServiceImpl

org.camunda.bpm.engine.impl.AuthorizationServiceImpl

All Implemented Interfaces:

AuthorizationService

public class AuthorizationServiceImpl
extends ServiceImpl
implements AuthorizationService

Author:

Daniel Meyer

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl

commandExecutor

Constructor Summary

Constructors

Constructor and Description
AuthorizationServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationQuery	createAuthorizationQuery() Constructs an authorization query.
Authorization	createNewAuthorization(int type) Returns a new (transient) Authorization object.
void	deleteAuthorization(String authorizationId) Allows deleting a persistent Authorization object.
boolean	isUserAuthorized(String userId, List<String> groupIds, Permission permission, Resource resource) Allows performing an authorization check.
boolean	isUserAuthorized(String userId, List<String> groupIds, Permission permission, Resource resource, String resourceId) Allows performing an authorization check.
Authorization	saveAuthorization(Authorization authorization) Allows saving an Authorization object.

Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthorizationServiceImpl

public AuthorizationServiceImpl()

Method Detail

createAuthorizationQuery

public AuthorizationQuery createAuthorizationQuery()

Description copied from interface: AuthorizationService

Constructs an authorization query.

Specified by:

createAuthorizationQuery in interface AuthorizationService

createNewAuthorization

public Authorization createNewAuthorization(int type)

Description copied from interface: AuthorizationService

Returns a new (transient) Authorization object. The Object is not yet persistent and must be saved using the AuthorizationService.saveAuthorization(Authorization) method.

Specified by:

createNewAuthorization in interface AuthorizationService

Parameters:

type - the type of the authorization. Legal values: Authorization.AUTH_TYPE_GLOBAL, Authorization.AUTH_TYPE_GRANT, Authorization.AUTH_TYPE_REVOKE

Returns:

an non-persistent Authorization object.

saveAuthorization

public Authorization saveAuthorization(Authorization authorization)

Description copied from interface: AuthorizationService

Allows saving an Authorization object. Use this method for persisting new transient Authorization objects obtained through AuthorizationService.createNewAuthorization(int) or for updating persistent objects.

Specified by:

saveAuthorization in interface AuthorizationService

Parameters:

authorization - a Authorization object.

Returns:

the authorization object.

deleteAuthorization

public void deleteAuthorization(String authorizationId)

Description copied from interface: AuthorizationService

Allows deleting a persistent Authorization object.

Specified by:

deleteAuthorization in interface AuthorizationService

Parameters:

authorizationId - the id of the Authorization object to delete.

isUserAuthorized

public boolean isUserAuthorized(String userId,
                       List<String> groupIds,
                       Permission permission,
                       Resource resource)

Description copied from interface: AuthorizationService

Allows performing an authorization check.

Returns true if the given user has permissions for interacting with the resource is the requested way.

This method checks for the resource type, see Authorization.ANY

Specified by:

isUserAuthorized in interface AuthorizationService

Parameters:

userId - the id of the user for which the check is performed.

groupIds - a list of group ids the user is member of

permission - the permission(s) to check for.

resource - the resource for which the authorization is checked.

isUserAuthorized

public boolean isUserAuthorized(String userId,
                       List<String> groupIds,
                       Permission permission,
                       Resource resource,
                       String resourceId)

Description copied from interface: AuthorizationService

Allows performing an authorization check.

Returns true if the given user has permissions for interacting with the resource is the requested way.

Specified by:

isUserAuthorized in interface AuthorizationService

Parameters:

userId - the id of the user for which the check is performed.

groupIds - a list of group ids the user is member of

permission - the permission(s) to check for.

resource - the resource for which the authorization is checked.

resourceId - the resource id for which the authorization check is performed.