|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.db.DBSecurityService
An implementation of SecurityService that uses a database as backend.
Field Summary | |
static java.lang.String |
USER_PEER_CLASS_DEFAULT
The default implementation of User interface (org.apache.turbine.om.security.DBUser) |
static java.lang.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.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 | |
DBSecurityService()
|
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. |
protected boolean |
checkExists(Group group)
Determines if the Group exists in the security system. |
protected boolean |
checkExists(Permission permission)
Determines if the Permission exists in the security system. |
protected boolean |
checkExists(Role role)
Determines if the Role exists in the security system. |
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. |
java.lang.Class |
getUserPeerClass()
Returns the Class object for the implementation of UserPeer interface used by the system (defined in TR.properties) |
UserPeer |
getUserPeerInstance()
Construct a UserPeer object. |
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(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 |
|
Methods inherited from interface org.apache.turbine.services.Service |
getConfiguration, getProperties, setName, setServiceBroker |
Methods inherited from interface org.apache.turbine.services.Initable |
getInit, init, init, setInitableBroker, shutdown |
Field Detail |
public static final java.lang.String USER_PEER_CLASS_KEY
public static final java.lang.String USER_PEER_CLASS_DEFAULT
Constructor Detail |
public DBSecurityService()
Method Detail |
public AccessControlList getACL(User user) throws DataBackendException, UnknownEntityException
user
- the user for whom the AccessControlList are to be retrievedDataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if user account is not present.public void grant(User user, Group group, Role role) throws DataBackendException, UnknownEntityException
User
- the user.Group
- the group.Role
- the role.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if user account, group or role is not present.public void revoke(User user, Group group, Role role) throws DataBackendException, UnknownEntityException
User
- the user.Group
- the group.Role
- the role.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if user account, group or role is not present.public void revokeAll(User user) throws DataBackendException, UnknownEntityException
user
- the User.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the account is not present.public void grant(Role role, Permission permission) throws DataBackendException, UnknownEntityException
role
- the Role.permission
- the Permission.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if role or permission is not present.public void revoke(Role role, Permission permission) throws DataBackendException, UnknownEntityException
role
- the Role.permission
- the Permission.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if role or permission is not present.public void revokeAll(Role role) throws DataBackendException, UnknownEntityException
role
- the RoleDataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the Role is not present.public GroupSet getGroups(Criteria criteria) throws DataBackendException
a
- Criteria of Group selection.public RoleSet getRoles(Criteria criteria) throws DataBackendException
a
- Criteria of Roles selection.public PermissionSet getPermissions(Criteria criteria) throws DataBackendException
a
- Criteria of Permissions selection.public PermissionSet getPermissions(Role role) throws DataBackendException, UnknownEntityException
role
- the role name, for which the permissions are to be retrieved.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the role is not present.public void saveGroup(Group group) throws DataBackendException, UnknownEntityException
group
- The Group to be stored.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.public void saveRole(Role role) throws DataBackendException, UnknownEntityException
role
- The Role to be stored.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the role does not exist.public void savePermission(Permission permission) throws DataBackendException, UnknownEntityException
permission
- The Permission to be stored.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the permission does not exist.public Group getNewGroup(java.lang.String groupName)
groupName
- The name of the Group to be retrieved.public Role getNewRole(java.lang.String roleName)
roleName
- The name of the Role to be retrieved.public Permission getNewPermission(java.lang.String permissionName)
permissionName
- The name of the Permission to be retrieved.public Group addGroup(Group group) throws DataBackendException, EntityExistsException
group
- the object describing the group to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the group already exists.public Role addRole(Role role) throws DataBackendException, EntityExistsException
role
- the object describing the role to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the role already exists.public Permission addPermission(Permission permission) throws DataBackendException, EntityExistsException
permission
- the object describing the permission to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the permission already exists.public void removeGroup(Group group) throws DataBackendException, UnknownEntityException
the
- object describing group to be removed.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.public void removeRole(Role role) throws DataBackendException, UnknownEntityException
the
- object describing role to be removed.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the role does not exist.public void removePermission(Permission permission) throws DataBackendException, UnknownEntityException
the
- object describing permission to be removed.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the permission does not exist.public void renameGroup(Group group, java.lang.String name) throws DataBackendException, UnknownEntityException
the
- object describing the group to be renamed.name
- the new name for the group.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the group does not exist.public void renameRole(Role role, java.lang.String name) throws DataBackendException, UnknownEntityException
the
- object describing the role to be renamed.name
- the new name for the role.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the role does not exist.public void renamePermission(Permission permission, java.lang.String name) throws DataBackendException, UnknownEntityException
the
- object describing the permission to be renamed.name
- the new name for the permission.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the permission does not exist.public java.lang.Class getUserPeerClass() throws UnknownEntityException
UnknownEntityException
- if the system's implementation of UserPeer
interface could not be determined.public UserPeer getUserPeerInstance() throws UnknownEntityException
UnknownEntityException
- if the object could not be instantiated.protected boolean checkExists(Group group) throws DataBackendException, java.lang.Exception
Group
exists in the security system.group
- a Group
valueDataBackendException
- when more than one Group with
the same name exists.Exception,
- a generic exception.protected boolean checkExists(Role role) throws DataBackendException, java.lang.Exception
Role
exists in the security system.role
- a Role
valueDataBackendException
- when more than one Role with
the same name exists.Exception,
- a generic exception.protected boolean checkExists(Permission permission) throws DataBackendException, java.lang.Exception
Permission
exists in the security system.permission
- a Permission
valueDataBackendException
- when more than one Permission with
the same name exists.Exception,
- a generic exception.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |