com.agapsys.security

Class AbstractAction

java.lang.Object

com.agapsys.security.RoleBasedObject

com.agapsys.security.AbstractAction

public abstract class AbstractAction
extends RoleBasedObject

Represents an action that will be executed only if required roles are available for execution.

Constructor Summary

Constructors

Constructor and Description
AbstractAction() Constructor Creates an action without any required role for its execution
AbstractAction(Role... requiredRoles) Constructor.
AbstractAction(String... requiredRoleNames) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addRequiredRole(Role... roles) Adds required roles to this action.
void	addRequiredRole(String... roleNames) Adds required roles to this action.
void	clearRequiredRoles() Remove all required roles associations.
void	execute(User user, Object... params) Execute this action.
Set<Role>	getRequiredRoles()
protected void	postRun(User user, Object... params) Called after action execution.
protected void	preRun(User user, Object... params) Called before action execution.
void	removeRequiredRole(Role... roles) Removes a required role.
void	removeRequiredRole(String... roleNames) Removes a required role.
protected abstract void	run(User user, Object... params) Actual action code.

Methods inherited from class com.agapsys.security.RoleBasedObject

addRole, addRole, clearRoles, getRoles, removeRole, removeRole

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAction

public AbstractAction()

Constructor Creates an action without any required role for its execution

See Also:

RoleBasedObject.RoleBasedObject()

AbstractAction

public AbstractAction(Role... requiredRoles)
               throws IllegalArgumentException,
                      DuplicateException

Constructor. Creates an action with a given set of required roles.

Parameters:

requiredRoles - required roles for execution.

Throws:

IllegalArgumentException - if any of given roles is null

DuplicateException - if there is an attempt to register the same role more than once (either directly of as a child of any associated role).

See Also:

RoleBasedObject.RoleBasedObject(Role...), run(User, Object...)

AbstractAction

public AbstractAction(String... requiredRoleNames)
               throws IllegalArgumentException,
                      DuplicateException,
                      RoleNotFoundException

Constructor. Creates an action with a given set of required roles.

Parameters:

requiredRoleNames - required roles for execution.

Throws:

IllegalArgumentException - if any of given roles is null

RoleNotFoundException - if any of given roleNames is not registered in RoleRepository

DuplicateException - if there is an attempt to register the same role more than once (either directly of as a child of any associated role).

See Also:

RoleBasedObject.RoleBasedObject(String...), run(User, Object...)

Method Detail

preRun

protected void preRun(User user,
                      Object... params)

Called before action execution. This method will be called only if security algorithm allowed action execution. Default implementation does nothing.

Parameters:

user - user running this action

params - parameters passed to action on execute(User, Object...)

run

protected abstract void run(User user,
                            Object... params)

Actual action code. Shall be implemented by subclasses

Parameters:

user - user running action

params - parameters passed to action on execute(User, Object...)

postRun

protected void postRun(User user,
                       Object... params)

Called after action execution. Default implementation does nothing

Parameters:

user - user running action

params - parameters passed to action on execute(User, Object...)

getRequiredRoles

public final Set<Role> getRequiredRoles()

Returns:

A read-only set of required roles for this action execution. This is a convenience method for RoleBasedObject.getRoles()

addRequiredRole

public final void addRequiredRole(Role... roles)
                           throws DuplicateException,
                                  IllegalArgumentException

Adds required roles to this action. This is a convenience method for RoleBasedObject.addRole(Role...)

Parameters:

roles - required roles. User running this action must have all required roles in order to proceed.

Throws:

IllegalArgumentException - if roles.length == 0 or any given role is null

DuplicateException - if given role was already associated to this object (either directly or as child of any associated role)

addRequiredRole

public final void addRequiredRole(String... roleNames)
                           throws DuplicateException,
                                  IllegalArgumentException,
                                  RoleNotFoundException

Adds required roles to this action. This is a convenience method for RoleBasedObject.addRole(String...)

Parameters:

roleNames - roles to be added. Role instances will be obtained through RoleRepository

Throws:

IllegalArgumentException - if roleNames.length == 0 or any of given roleNames is null/empty

DuplicateException - if given role was already associated to this object (either directly or as child of any associated role)

RoleNotFoundException - if any of given roleNames is not registered in RoleRepository

removeRequiredRole

public final void removeRequiredRole(Role... roles)
                              throws IllegalArgumentException

Removes a required role. This is a convenience method for RoleBasedObject.removeRole(Role...)

Parameters:

roles - role to be removed from association set. If given role is not associated to this instance, nothing happens.

Throws:

IllegalArgumentException - if roles.length == 0 or any of given roles is null

removeRequiredRole

public final void removeRequiredRole(String... roleNames)
                              throws IllegalArgumentException,
                                     RoleNotFoundException

Removes a required role. This is a convenience method for RoleBasedObject.removeRole(Role...)

Parameters:

roleNames - role to be removed from association set. If given role is not associated to this instance, nothing happens. Role instances will be obtained through RoleRepository

Throws:

IllegalArgumentException - if roleNames.length == 0 or any given role is null/empty

RoleNotFoundException - if any given role is not registered in RoleRepository

clearRequiredRoles

public final void clearRequiredRoles()

Remove all required roles associations. This is a convenience method for RoleBasedObject.clearRoles()

execute

public final void execute(User user,
                          Object... params)
                   throws SecurityException

Execute this action.

Parameters:

user - user calling this action. Given user must fulfill (via see User.getRoles()) all required roles (see getRequiredRoles()) in order to execute this action

params - extra parameters passed to action execution.

Throws:

SecurityException - If user does not fulfill required roles.