org.apache.turbine.test
Class MockSecurityService

java.lang.Object
  extended by org.apache.turbine.services.BaseInitable
      extended by org.apache.turbine.services.BaseService
          extended by org.apache.turbine.services.TurbineBaseService
              extended by org.apache.turbine.services.security.BaseSecurityService
                  extended by org.apache.turbine.test.MockSecurityService
All Implemented Interfaces:
Initable, SecurityService, Service

public class MockSecurityService
extends BaseSecurityService

An Mock implementation of SecurityService. Basically replacing existing database methods as needed for a test case.

Version:
$Id: MockSecurityService.java 615328 2008-01-25 20:25:05Z tv $
Author:
Eric Pugh

Field Summary
static String USER_PEER_CLASS_DEFAULT
          The default implementation of User interface (org.apache.turbine.om.security.DBUser)
static String USER_PEER_CLASS_KEY
          The key within services's properties for user implementation classname (user.class) - Leandro
 
Fields inherited from class org.apache.turbine.services.BaseService
configuration, name, serviceBroker
 
Fields inherited from class org.apache.turbine.services.BaseInitable
initableBroker, isInitialized
 
Fields inherited from interface org.apache.turbine.services.security.SecurityService
ACL_CLASS_DEFAULT, ACL_CLASS_KEY, GROUP_CLASS_DEFAULT, GROUP_CLASS_KEY, PERMISSION_CLASS_DEFAULT, PERMISSION_CLASS_KEY, ROLE_CLASS_DEFAULT, ROLE_CLASS_KEY, SECURE_PASSWORDS_ALGORITHM_DEFAULT, SECURE_PASSWORDS_ALGORITHM_KEY, SECURE_PASSWORDS_DEFAULT, SECURE_PASSWORDS_KEY, SERVICE_NAME, USER_CLASS_DEFAULT, USER_CLASS_KEY, USER_MANAGER_DEFAULT, USER_MANAGER_KEY
 
Constructor Summary
MockSecurityService()
           
 
Method Summary
 Group addGroup(Group group)
          Creates a new group with specified attributes.
 Permission addPermission(Permission permission)
          Creates a new permission with specified attributes.
 Role addRole(Role role)
          Creates a new role with specified attributes.
 AccessControlList getACL(User user)
          Constructs an AccessControlList for a specific user.
 GroupSet getAllGroups()
           
 PermissionSet getAllPermissions()
           
 RoleSet getAllRoles()
           
 GroupSet getGroups(Object criteria)
          Retrieve a set of Groups that meet the specified Criteria.
 PermissionSet getPermissions(Object criteria)
          Retrieve a set of Permissions that meet the specified Criteria.
 PermissionSet getPermissions(Role role)
          Retrieves all permissions associated with a role.
 RoleSet getRoles(Object criteria)
          Retrieve a set of Roles that meet the specified Criteria.
 List getUserList(Object criteria)
           
 void grant(Role role, Permission permission)
          Grants a Role a Permission
 void grant(User user, Group group, Role role)
          Grant an User a Role in a Group.
 void removeGroup(Group group)
          Removes a Group from the system.
 void removePermission(Permission permission)
          Removes a Permission from the system.
 void removeRole(Role role)
          Removes a Role from the system.
 void renameGroup(Group group, String name)
          Renames an existing Group.
 void renamePermission(Permission permission, String name)
          Renames an existing Permission.
 void renameRole(Role role, String name)
          Renames an existing Role.
 void revoke(Role role, Permission permission)
          Revokes a Permission from a Role.
 void revoke(User user, Group group, Role role)
          Revoke a Role in a Group from an User.
 void revokeAll(Role role)
          Revokes all permissions from a Role.
 void revokeAll(User user)
          Revokes all roles from an User.
 void saveGroup(Group group)
          Stores Group's attributes.
 void savePermission(Permission permission)
          Stores Permission's attributes.
 void saveRole(Role role)
          Stores Role's attributes.
 
Methods inherited from class org.apache.turbine.services.security.BaseSecurityService
accountExists, accountExists, addUser, changePassword, checkPassword, encryptPassword, encryptPassword, forcePassword, getAclClass, getAclInstance, getAnonymousUser, getAuthenticatedUser, getGlobalGroup, getGroupById, getGroupByName, getGroupClass, getGroupInstance, getGroupInstance, getPermissionById, getPermissionByName, getPermissionClass, getPermissionInstance, getPermissionInstance, getRoleById, getRoleByName, getRoleClass, getRoleInstance, getRoleInstance, getUser, getUserClass, getUserInstance, getUserInstance, getUserManager, init, isAnonymousUser, lockExclusive, lockShared, removeUser, saveOnSessionUnbind, saveUser, setUserManager, unlockExclusive, unlockShared
 
Methods inherited from class org.apache.turbine.services.TurbineBaseService
init, init, init, shutdown
 
Methods inherited from class org.apache.turbine.services.BaseService
getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker
 
Methods inherited from class org.apache.turbine.services.BaseInitable
getInit, getInitableBroker, setInit, setInitableBroker
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, setInitableBroker, shutdown
 

Field Detail

USER_PEER_CLASS_KEY

public static final String USER_PEER_CLASS_KEY
The key within services's properties for user implementation classname (user.class) - Leandro

See Also:
Constant Field Values

USER_PEER_CLASS_DEFAULT

public static final String USER_PEER_CLASS_DEFAULT
The default implementation of User interface (org.apache.turbine.om.security.DBUser)

See Also:
Constant Field Values
Constructor Detail

MockSecurityService

public MockSecurityService()
Method Detail

getACL

public AccessControlList getACL(User user)
                         throws DataBackendException,
                                UnknownEntityException
Constructs an AccessControlList for a specific user. This method creates a snapshot of the state of security information concerning this user, at the moment of invocation and stores it into an AccessControlList object.

Parameters:
user - the user for whom the AccessControlList are to be retrieved
Returns:
A new AccessControlList object.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if user account is not present.

grant

public void grant(User user,
                  Group group,
                  Role role)
           throws DataBackendException,
                  UnknownEntityException
Grant an User a Role in a Group.

Parameters:
user - the user.
group - the group.
role - the role.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if user account, group or role is not present.

revoke

public void revoke(User user,
                   Group group,
                   Role role)
            throws DataBackendException,
                   UnknownEntityException
Revoke a Role in a Group from an User.

Parameters:
user - the user.
group - the group.
role - the role.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if user account, group or role is not present.

revokeAll

public void revokeAll(User user)
               throws DataBackendException,
                      UnknownEntityException
Revokes all roles from an User. This method is used when deleting an account.

Parameters:
user - the User.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the account is not present.

grant

public void grant(Role role,
                  Permission permission)
           throws DataBackendException,
                  UnknownEntityException
Grants a Role a Permission

Parameters:
role - the Role.
permission - the Permission.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if role or permission is not present.

revoke

public void revoke(Role role,
                   Permission permission)
            throws DataBackendException,
                   UnknownEntityException
Revokes a Permission from a Role.

Parameters:
role - the Role.
permission - the Permission.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if role or permission is not present.

revokeAll

public void revokeAll(Role role)
               throws DataBackendException,
                      UnknownEntityException
Revokes all permissions from a Role. This method is user when deleting a Role.

Parameters:
role - the Role
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the Role is not present.

getGroups

public GroupSet getGroups(Object criteria)
                   throws DataBackendException
Retrieve a set of Groups that meet the specified Criteria.

Parameters:
criteria - A Criteria of Group selection.
Returns:
a set of Groups that meet the specified Criteria.
Throws:
DataBackendException - if there was an error accessing the data backend.

getRoles

public RoleSet getRoles(Object criteria)
                 throws DataBackendException
Retrieve a set of Roles that meet the specified Criteria.

Parameters:
criteria - A Criteria of Roles selection.
Returns:
a set of Roles that meet the specified Criteria.
Throws:
DataBackendException - if there was an error accessing the data backend.

getPermissions

public PermissionSet getPermissions(Object criteria)
                             throws DataBackendException
Retrieve a set of Permissions that meet the specified Criteria.

Parameters:
criteria - A Criteria of Permissions selection.
Returns:
a set of Permissions that meet the specified Criteria.
Throws:
DataBackendException - if there was an error accessing the data backend.

getPermissions

public PermissionSet getPermissions(Role role)
                             throws DataBackendException,
                                    UnknownEntityException
Retrieves all permissions associated with a role.

Parameters:
role - the role name, for which the permissions are to be retrieved.
Returns:
A Permission set for the Role.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the role is not present.

saveGroup

public void saveGroup(Group group)
               throws DataBackendException,
                      UnknownEntityException
Stores Group's attributes. The Groups is required to exist in the system.

Parameters:
group - The Group to be stored.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the group does not exist.

saveRole

public void saveRole(Role role)
              throws DataBackendException,
                     UnknownEntityException
Stores Role's attributes. The Roles is required to exist in the system.

Parameters:
role - The Role to be stored.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the role does not exist.

savePermission

public void savePermission(Permission permission)
                    throws DataBackendException,
                           UnknownEntityException
Stores Permission's attributes. The Permissions is required to exist in the system.

Parameters:
permission - The Permission to be stored.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the permission does not exist.

addGroup

public Group addGroup(Group group)
               throws DataBackendException,
                      EntityExistsException
Creates a new group with specified attributes.

Parameters:
group - the object describing the group to be created.
Returns:
a new Group object that has id set up properly.
Throws:
DataBackendException - if there was an error accessing the data backend.
EntityExistsException - if the group already exists.

addRole

public Role addRole(Role role)
             throws DataBackendException,
                    EntityExistsException
Creates a new role with specified attributes.

Parameters:
role - the object describing the role to be created.
Returns:
a new Role object that has id set up properly.
Throws:
DataBackendException - if there was an error accessing the data backend.
EntityExistsException - if the role already exists.

addPermission

public Permission addPermission(Permission permission)
                         throws DataBackendException,
                                EntityExistsException
Creates a new permission with specified attributes.

Parameters:
permission - the object describing the permission to be created.
Returns:
a new Permission object that has id set up properly.
Throws:
DataBackendException - if there was an error accessing the data backend.
EntityExistsException - if the permission already exists.

removeGroup

public void removeGroup(Group group)
                 throws DataBackendException,
                        UnknownEntityException
Removes a Group from the system.

Parameters:
group - The object describing the group to be removed.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the group does not exist.

removeRole

public void removeRole(Role role)
                throws DataBackendException,
                       UnknownEntityException
Removes a Role from the system.

Parameters:
role - The object describing the role to be removed.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the role does not exist.

removePermission

public void removePermission(Permission permission)
                      throws DataBackendException,
                             UnknownEntityException
Removes a Permission from the system.

Parameters:
permission - The object describing the permission to be removed.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the permission does not exist.

renameGroup

public void renameGroup(Group group,
                        String name)
                 throws DataBackendException,
                        UnknownEntityException
Renames an existing Group.

Parameters:
group - The object describing the group to be renamed.
name - the new name for the group.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the group does not exist.

renameRole

public void renameRole(Role role,
                       String name)
                throws DataBackendException,
                       UnknownEntityException
Renames an existing Role.

Parameters:
role - The object describing the role to be renamed.
name - the new name for the role.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the role does not exist.

renamePermission

public void renamePermission(Permission permission,
                             String name)
                      throws DataBackendException,
                             UnknownEntityException
Renames an existing Permission.

Parameters:
permission - The object describing the permission to be renamed.
name - the new name for the permission.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the permission does not exist.

getAllGroups

public GroupSet getAllGroups()
                      throws DataBackendException
Specified by:
getAllGroups in interface SecurityService
Specified by:
getAllGroups in class BaseSecurityService
Throws:
DataBackendException

getAllPermissions

public PermissionSet getAllPermissions()
                                throws DataBackendException
Specified by:
getAllPermissions in interface SecurityService
Specified by:
getAllPermissions in class BaseSecurityService
Throws:
DataBackendException

getAllRoles

public RoleSet getAllRoles()
                    throws DataBackendException
Specified by:
getAllRoles in interface SecurityService
Specified by:
getAllRoles in class BaseSecurityService
Throws:
DataBackendException

getUserList

public List getUserList(Object criteria)
                 throws DataBackendException
Throws:
DataBackendException


Copyright © 2000-2011 The Apache Software Foundation. All Rights Reserved.