org.apache.turbine.services.security.ldap
Class LDAPSecurityService

java.lang.Object
  |
  +--org.apache.turbine.services.BaseInitable
        |
        +--org.apache.turbine.services.BaseService
              |
              +--org.apache.turbine.services.TurbineBaseService
                    |
                    +--org.apache.turbine.services.security.BaseSecurityService
                          |
                          +--org.apache.turbine.services.security.ldap.LDAPSecurityService
All Implemented Interfaces:
Initable, SecurityService, Service

public class LDAPSecurityService
extends BaseSecurityService

An implementation of SecurityService that uses LDAP as a backend.

Version:
$Id: LDAPSecurityService.java,v 1.3 2001/12/14 17:18:53 henning Exp $
Author:
Rafal Krzewski, Tracy M. Adewunmi , Leonard J. Flournoy , Jason van Zyl, Marco Knüttel

Fields inherited from class org.apache.turbine.services.security.BaseSecurityService
allGroups, allPermissions, allRoles, globalGroup, readerCount, userClass, userManager
 
Fields inherited from class org.apache.turbine.services.BaseService
configuration, name, properties, serviceBroker
 
Fields inherited from class org.apache.turbine.services.BaseInitable
initableBroker, isInitialized
 
Fields inherited from interface org.apache.turbine.services.security.SecurityService
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
LDAPSecurityService()
           
 
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 getGroups(Criteria criteria)
          Retrieve a set of Groups that meet the specified Criteria.
 Group getNewGroup(java.lang.String groupName)
          Retrieves a new Group.
 Permission getNewPermission(java.lang.String permissionName)
          Retrieves a new Permission.
 Role getNewRole(java.lang.String roleName)
          Retrieves a new Role.
 PermissionSet getPermissions(Criteria criteria)
          Retrieve a set of Permissions that meet the specified Criteria.
 PermissionSet getPermissions(Role role)
          Retrieves all permissions associated with a role.
 RoleSet getRoles(Criteria criteria)
          Retrieve a set of Roles that meet the specified 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, java.lang.String name)
          Renames an existing Group.
 void renamePermission(Permission permission, java.lang.String name)
          Renames an existing Permission.
 void renameRole(Role role, java.lang.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(Group group)
           
 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, encryptPassword, forcePassword, getAllGroups, getAllPermissions, getAllRoles, getAnonymousUser, getAuthenticatedUser, getGlobalGroup, getGroup, getPermission, getRole, getUser, getUserClass, getUserInstance, getUsers, init, lockExclusive, lockShared, removeUser, saveUser, 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, registerNatives, 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, init, setInitableBroker, shutdown
 

Constructor Detail

LDAPSecurityService

public LDAPSecurityService()
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
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.

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.

getNewGroup

public Group getNewGroup(java.lang.String groupName)
Retrieves a new Group. It creates a new Group based on the Services Group implementation. It does not create a new Group in the system though. Use addGroup for that. Not implemented
Parameters:
groupName - The name of the Group to be retrieved.

getNewRole

public Role getNewRole(java.lang.String roleName)
Retrieves a new Role. It creates a new Role based on the Services Role implementation. It does not create a new Role in the system though. Use addRole for that. Not implemented
Parameters:
groupName - The name of the Group to be retrieved.

getNewPermission

public Permission getNewPermission(java.lang.String permissionName)
Retrieves a new Permission. It creates a new Permission based on the Services Permission implementation. It does not create a new Permission in the system though. Use create for that. Not implemented
Parameters:
permissionName - The name of the Permission to be retrieved.

getGroups

public GroupSet getGroups(Criteria criteria)
                   throws DataBackendException
Retrieve a set of Groups that meet the specified Criteria.
Parameters:
a - Criteria of Group selection.
Returns:
a set of Groups that meet the specified Criteria.

getRoles

public RoleSet getRoles(Criteria criteria)
                 throws DataBackendException
Retrieve a set of Roles that meet the specified Criteria.
Parameters:
a - Criteria of Roles selection.
Returns:
a set of Roles that meet the specified Criteria.

getPermissions

public PermissionSet getPermissions(Criteria criteria)
                             throws DataBackendException
Retrieve a set of Permissions that meet the specified Criteria.
Parameters:
a - Criteria of Permissions selection.
Returns:
a set of Permissions that meet the specified Criteria.

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.
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. Not implemented
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. Not implemented
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:
the - object describing 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:
the - object describing 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:
the - object describing 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,
                        java.lang.String name)
                 throws DataBackendException,
                        UnknownEntityException
Renames an existing Group.
Parameters:
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,
                       java.lang.String name)
                throws DataBackendException,
                       UnknownEntityException
Renames an existing Role.
Parameters:
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,
                             java.lang.String name)
                      throws DataBackendException,
                             UnknownEntityException
Renames an existing Permission.
Parameters:
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.

revokeAll

public void revokeAll(User user)
Description copied from interface: SecurityService
Revokes all roles from an User. This method is used when deleting an account.
Following copied from interface: org.apache.turbine.services.security.SecurityService
Parameters:
user - the User.
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the account is not present.

revokeAll

public void revokeAll(Role role)
Description copied from interface: SecurityService
Revokes all permissions from a Role. This method is user when deleting a Role.
Following copied from interface: org.apache.turbine.services.security.SecurityService
Parameters:
role - the Role
Throws:
DataBackendException - if there was an error accessing the data backend.
UnknownEntityException - if the Role is not present.

revokeAll

public void revokeAll(Group group)


Copyright © 2000-2002 Apache Software Foundation. All Rights Reserved.