com.edorasware.one.permission.action

Interface ActionPermissionManager

public interface ActionPermissionManager

Method Summary

Methods

Modifier and Type	Method and Description
Action	getActionById(String actionId, com.google.common.base.Optional<? extends com.edorasware.commons.core.entity.WorkObjectId> workObjectId) Returns the Action instance for the given action id.
com.google.common.collect.ImmutableCollection<Action>	getAllowedActions(ContextAction context, com.google.common.base.Optional<? extends com.edorasware.commons.core.entity.WorkObjectId> workObjectId) Returns the allowed Actions for the specified ContextAction and the work object id.
com.google.common.collect.ImmutableCollection<Action>	getAllowedActionsForType(TypeAction typeAction) Returns the allowed Actions for the specified TypeAction.
boolean	isActionAllowed(ActionName action, ContextAction context, com.google.common.base.Optional<? extends com.edorasware.commons.core.entity.WorkObjectId> workObjectId) Checks if the action is allowed in the given context and for the given work object.

Method Detail

getAllowedActions

com.google.common.collect.ImmutableCollection<Action> getAllowedActions(ContextAction context,
                                                                      com.google.common.base.Optional<? extends com.edorasware.commons.core.entity.WorkObjectId> workObjectId)

Returns the allowed Actions for the specified ContextAction and the work object id. The privileges of the current user are also involved in the permission process.

Parameters:

context - the action context for which the allowed actions should be returned

workObjectId - the work object id for which the allowed actions should be returned

Returns:

the allowed actions for the specified action context and work object id

Throws:

IllegalArgumentException - if an input parameter is not valid

RuntimeException - if an error occurs while getting the allowed actions for the current user

getAllowedActionsForType

com.google.common.collect.ImmutableCollection<Action> getAllowedActionsForType(TypeAction typeAction)

Returns the allowed Actions for the specified TypeAction.

Parameters:

typeAction - the type for which to retrieve the actions

Returns:

the allowed actions for the specified type

Throws:

IllegalArgumentException - if the type is not known

RuntimeException - if an error occurs while getting the allowed actions for the type

isActionAllowed

boolean isActionAllowed(ActionName action,
                      ContextAction context,
                      com.google.common.base.Optional<? extends com.edorasware.commons.core.entity.WorkObjectId> workObjectId)

Checks if the action is allowed in the given context and for the given work object.

Parameters:

action - the action which is checked if it is allowed

context - the context for which the action is checked if it is allowed

workObjectId - the work object id for which the action is checked if it is allowed

Returns:

true if the action is allowed, false otherwise

Throws:

IllegalArgumentException - if an input parameter is not valid

RuntimeException - if an error occurs while checking if the action is allowed

getActionById

Action getActionById(String actionId,
                   com.google.common.base.Optional<? extends com.edorasware.commons.core.entity.WorkObjectId> workObjectId)

Returns the Action instance for the given action id. If the id is not known a generated "unknown" action is returned.

Parameters:

actionId - the action id for which the action instance should be created

workObjectId - the work object id for which the action should be returned

Returns:

the action instance for the given action name

Throws:

RuntimeException - if the action is not allowed in the context of the given work object id