|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.turbine.services.security.TurbineSecurity
This is a Facade class for SecurityService.
This class provides static methods that call related methods of the
implementation of SecurityService used by the System, according to
the settings in TurbineResources.
Certain Roles that the Users may have in the system may are not related
to any specific resource nor entity. They are assigned within a special group
named 'global' that can be referenced in the code as
Group.GLOBAL_GROUP_NAME
.
Constructor Summary | |
TurbineSecurity()
|
Method Summary | |
static boolean |
accountExists(java.lang.String username)
Check whether a specified user's account exists. |
static boolean |
accountExists(User user)
Check whether a specified user's account exists. |
static void |
addGroup(Group group)
Creates a new group with specified attributes. |
static void |
addPermission(Permission permission)
Creates a new permission with specified attributes. |
static void |
addRole(Role role)
Creates a new role with specified attributes. |
static void |
addUser(User user,
java.lang.String password)
Creates new user account with specified attributes. |
static void |
changePassword(User user,
java.lang.String oldPassword,
java.lang.String newPassword)
Change the password for an User. |
static Group |
createGroup(java.lang.String name)
Creates a new Group in the system. |
static Permission |
createPermission(java.lang.String name)
Creates a new Permission in the system. |
static java.lang.String |
encryptPassword(java.lang.String password)
|
static void |
forcePassword(User user,
java.lang.String password)
Forcibly sets new password for an User. |
static AccessControlList |
getACL(User user)
Constructs an AccessControlList for a specific user. |
static GroupSet |
getAllGroups()
Retrieves all groups defined in the system. |
static PermissionSet |
getAllPermissions()
Retrieves all permissions defined in the system. |
static RoleSet |
getAllRoles()
Retrieves all roles defined in the system. |
static User |
getAnonymousUser()
Constructs an User object to represent an anonymous user of the application. |
static User |
getAuthenticatedUser(java.lang.String username,
java.lang.String password)
Authenticates an user, and constructs an User object to represent him/her. |
static Group |
getGlobalGroup()
Provides a reference to the Group object that represents the global group. |
static Group |
getGroup(java.lang.String groupName)
Retrieves a named Group. |
static GroupSet |
getGroups(Criteria criteria)
Retrieve a set of Groups that meet the specified Criteria. |
static Group |
getNewGroup(java.lang.String groupName)
Retrieves a named Group. |
static Permission |
getNewPermission(java.lang.String permissionName)
Retrieves a named Permission. |
static Role |
getNewRole(java.lang.String roleName)
Retrieves a named Permission. |
static Permission |
getPermission(java.lang.String permissionName)
Retrieves a named Permission. |
static PermissionSet |
getPermissions(Criteria criteria)
Retrieve a set of Permissions that meet the specified Criteria. |
static PermissionSet |
getPermissions(Role role)
Retrieves all permissions associated with a role. |
static Role |
getRole(java.lang.String roleName)
Retrieves a named Role. |
static RoleSet |
getRoles(Criteria criteria)
Retrieve a set of Roles that meet the specified Criteria. |
static SecurityService |
getService()
Retrieves an implementation of SecurityService, base on the settings in TurbineResources. |
static User |
getUser(java.lang.String username)
Constructs an User object to represent a registered user of the application. |
static java.lang.Class |
getUserClass()
Return a Class object representing the system's chosen implementation of of User interface. |
static User |
getUserInstance()
Construct a blank User object. |
static User[] |
getUsers(Criteria criteria)
Retrieve a set of users that meet the specified criteria. |
static void |
grant(Role role,
Permission permission)
Grants a Role a Permission |
static void |
grant(User user,
Group group,
Role role)
Grant an User a Role in a Group. |
static void |
removeGroup(Group group)
Removes a Group from the system. |
static void |
removePermission(Permission permission)
Removes a Permission from the system. |
static void |
removeRole(Role role)
Removes a Role from the system. |
static void |
removeUser(User user)
Removes an user account from the system. |
static void |
renameGroup(Group group,
java.lang.String name)
Renames an existing Group. |
static void |
renamePermission(Permission permission,
java.lang.String name)
Renames an existing Permission. |
static void |
renameRole(Role role,
java.lang.String name)
Renames an existing Role. |
static void |
revoke(Role role,
Permission permission)
Revokes a Permission from a Role. |
static void |
revoke(User user,
Group group,
Role role)
Revoke a Role in a Group from an User. |
static void |
revokeAll(Role role)
Revokes all permissions from a Role. |
static void |
revokeAll(User user)
Revokes all roles from an User. |
static void |
saveGroup(Group group)
Stores Group's attributes. |
static void |
savePermission(Permission permission)
Stores Permission's attributes. |
static void |
saveRole(Role role)
Stores Role's attributes. |
static void |
saveUser(User user)
Saves User's data in the permanent storage. |
Methods inherited from class java.lang.Object |
|
Constructor Detail |
public TurbineSecurity()
Method Detail |
public static SecurityService getService()
public static java.lang.String encryptPassword(java.lang.String password)
public static java.lang.Class getUserClass() throws UnknownEntityException
UnknownEntityException
- if the implementation of User interface
could not be determined, or does not exist.public static User getUserInstance() throws UnknownEntityException
UnknownEntityException
- if the object could not be instantiated.public static boolean accountExists(User user) throws DataBackendException
user
- The user to be checked.DataBackendException
- if there was an error accessing the data backend.public static boolean accountExists(java.lang.String username) throws DataBackendException
usename
- The name of the user to be checked.DataBackendException
- if there was an error accessing the data backend.public static User getAuthenticatedUser(java.lang.String username, java.lang.String password) throws DataBackendException, UnknownEntityException, PasswordMismatchException
username
- The user name.password
- The user password.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if user account is not present.PasswordMissmatchException
- if the supplied password was incorrect.public static User getUser(java.lang.String username) throws DataBackendException, UnknownEntityException
username
- The user name.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if user account is not present.public static User[] getUsers(Criteria criteria) throws DataBackendException
User
interface, plus the names
of the custom attributes you added to your user representation
in the data storage. Use verbatim names of the attributes -
without table name prefix in case of DB implementation.criteria
- The criteria of selection.DataBackendException
- if there is a problem accessing the
storage.public static User getAnonymousUser() throws UnknownEntityException
UnknownEntityException
- if the anonymous User object couldn't be
constructed.public static void saveUser(User user) throws UnknownEntityException, DataBackendException
UnknownEntityException
- if the user's account does not
exist in the database.DataBackendException
- if there is a problem accessing the
storage.public static void changePassword(User user, java.lang.String oldPassword, java.lang.String newPassword) throws PasswordMismatchException, UnknownEntityException, DataBackendException
user
- an User to change password for.oldPassword
- the current password supplied by the user.newPassword
- the current password requested by the user.PasswordMismatchException
- if the supplied password was
incorrect.UnknownEntityException
- if the user's record does not
exist in the database.DataBackendException
- if there is a problem accessing the
storage.public static void forcePassword(User user, java.lang.String password) throws UnknownEntityException, DataBackendException
user
- an User to change password for.password
- the new password.UnknownEntityException
- if the user's record does not
exist in the database.DataBackendException
- if there is a problem accessing the
storage.public static 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 static 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 static 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 static 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 static 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 static 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 static 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 static void addUser(User user, java.lang.String password) throws DataBackendException, EntityExistsException
user
- the object describing account to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the user account already exists.public static void removeUser(User user) throws DataBackendException, UnknownEntityException
user
- the object describing the account to be removed.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the user account is not present.public static Group getGlobalGroup()
public static Group createGroup(java.lang.String name) throws TurbineSecurityException
name
- The name of the new Group.TurbineSecurityException
- if the Group could not be created.public static Permission createPermission(java.lang.String name) throws TurbineSecurityException
name
- The name of the new Permission.TurbineSecurityException
- if the Permission could not be created.public static Group getGroup(java.lang.String groupName) throws DataBackendException, UnknownEntityException
groupName
- The name of the Group to be retrieved.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the Group is not present.public static Group getNewGroup(java.lang.String groupName) throws DataBackendException
groupName
- The name of the Group to be retrieved.DataBackendException
- if there was an error accessing the data backend.public static Role getNewRole(java.lang.String roleName) throws TurbineSecurityException
roleName
- The name of the Role to be retrieved.DataBackendException
- if there was an error accessing the data backend.public static Permission getNewPermission(java.lang.String permissionName) throws DataBackendException
groupName
- The name of the Permission to be retrieved.DataBackendException
- if there was an error accessing the data backend.public static Role getRole(java.lang.String roleName) throws DataBackendException, UnknownEntityException
roleName
- The name of the Role to be retrieved.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the Role is not present.public static Permission getPermission(java.lang.String permissionName) throws DataBackendException, UnknownEntityException
permissionName
- The name of the Permission to be retrieved.DataBackendException
- if there was an error accessing the data backend.UnknownEntityException
- if the Permission is not present.public static GroupSet getGroups(Criteria criteria) throws DataBackendException
a
- Criteria of Group selection.public static RoleSet getRoles(Criteria criteria) throws DataBackendException
criteria
- a Criteria of Roles selection.public static PermissionSet getPermissions(Criteria criteria) throws DataBackendException
criteria
- a Criteria of Permissions selection.public static GroupSet getAllGroups() throws DataBackendException
public static RoleSet getAllRoles() throws DataBackendException
DataBackendException
- if there was an error accessing the data backend.public static PermissionSet getAllPermissions() throws DataBackendException
DataBackendException
- if there was an error accessing the data backend.public static 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 static 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 static 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 static 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 static void 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 static void addRole(Role role) throws DataBackendException, EntityExistsException
group
- the objects describing the group to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the role already exists.public static void addPermission(Permission permission) throws DataBackendException, EntityExistsException
group
- the objects describing the group to be created.DataBackendException
- if there was an error accessing the data backend.EntityExistsException
- if the permission already exists.public static 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 static 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 static 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 static 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 static 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 static 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |