com.whitestein.lsps.os

Interface SecurityService

All Known Subinterfaces:

SecurityServiceLocal, SecurityServiceRemote

All Known Implementing Classes:

SecurityServiceBean

public interface SecurityService

Provides methods for users, security roles, and rights management (CRUD operations, user-security role mapping, security role-right mapping).

Since:

1.3

Author:

vgr

Method Summary

Modifier and Type	Method and Description
SecurityRole	addSecurityRole(SecurityRole securityRole) Adds new security role into the application.
Set<String>	findRights() Returns a set of all rights that are used.
Collection<SecurityRole>	findSecurityRoles() Returns a collection of all security roles that already exist .
SecurityRole	getSecurityRole(String securityRoleName) Returns a SecurityRole instance if such security role (identified by given securityRoleName) exists .
void	removeSecurityRole(String securityRoleName) Removes the security role identified by given securityRoleName from the application.
SecurityRole	updateSecurityRole(SecurityRole securityRole) Updates a security role by its id.

Method Detail

addSecurityRole

SecurityRole addSecurityRole(SecurityRole securityRole)
                      throws SecurityRoleAlreadyExistsException

Adds new security role into the application.

Parameters:

securityRole - security role to be added

Returns:

added security role with the id

Throws:

NullPointerException - if the securityRole argument is null.

SecurityRoleAlreadyExistsException - if the securityRole already exists .

updateSecurityRole

SecurityRole updateSecurityRole(SecurityRole securityRole)
                         throws SecurityRoleStaleException,
                                SecurityRoleAlreadyExistsException,
                                SecurityRoleNotFoundException

Updates a security role by its id.

Parameters:

securityRole - security role to be updated

Returns:

updated security role

Throws:

NullPointerException - if securityRole or id of securityRole is null

SecurityRoleNotFoundException - if the role identified by securityRole does not exist

SecurityRoleAlreadyExistsException - if changing name and a role with the same name already exists

SecurityRoleStaleException - if securityRole object is stale (this applies only if the version is not null)

removeSecurityRole

void removeSecurityRole(String securityRoleName)
                 throws SecurityRoleNotFoundException

Removes the security role identified by given securityRoleName from the application.

Parameters:

securityRoleName - The name of the security role to remove. Cannot be blank.

Throws:

NullPointerException - if the securityRoleName argument is null.

IllegalArgumentException - if the securityRoleName argument contains just whitespace characters.

SecurityRoleNotFoundException - if the security role identified by its securityRoleName does not exist in the application.

getSecurityRole

SecurityRole getSecurityRole(String securityRoleName)

Returns a SecurityRole instance if such security role (identified by given securityRoleName) exists .

Parameters:

securityRoleName - The name of the security role to find. Cannot be blank.

Returns:

The SecurityRole instance if such security role exists , otherwise null.

Throws:

NullPointerException - if the securityRoleName argument is null.

IllegalArgumentException - if the securityRoleName argument contains just whitespace characters.

findSecurityRoles

Collection<SecurityRole> findSecurityRoles()

Returns a collection of all security roles that already exist .

Returns:

A collection of all security roles that already exist or empty collection if no security role was found.

findRights

Set<String> findRights()

Returns a set of all rights that are used.

Returns:

A set of all rights that are used.