corelib.security
Interface RoleManager

public interface RoleManager

This interface defines the methods used to manage Role instances. To can get a RoleManager instance by asking it at your SecurityManager.

Since:

0.3.6

Author:

Dominique Liard

See Also:

SecurityManager, JdbcSecurityManager, Role

Method Summary

void	deleteRole(Role role) Delete, on the security system, the specified role.
Role	insertRole(java.lang.String roleName) Insert a new role into the used security system.
Role	selectRoleById(int roleIdentifier) Select the role with the identifier specified in parameter.
Role	selectRoleByName(java.lang.String roleName) Select the role with the name specified in parameter.
void	updateRole(Role role) Update the informations for this role (actually, only the role name).

Method Detail

selectRoleById

Role selectRoleById(int roleIdentifier)
                    throws SecurityManagerException

Select the role with the identifier specified in parameter.

Parameters:

roleIdentifier - The identifier of the role to returns.

Returns:

The selected role.

Throws:

SecurityManagerException - Thrown if the searched role don't exists.

selectRoleByName

Role selectRoleByName(java.lang.String roleName)
                      throws SecurityManagerException

Select the role with the name specified in parameter.

Parameters:

roleName - The name of the role to returns.

Returns:

The selected role.

Throws:

SecurityManagerException - Thrown if the searched role don't exists.

insertRole

Role insertRole(java.lang.String roleName)
                throws SecurityManagerException,
                       RoleAlreadyRegisteredException

Insert a new role into the used security system.

Parameters:

roleName - The name of the new role.

Returns:

The new role.

Throws:

SecurityManagerException - Thrown if the role cannot be inserted into the security system.

RoleAlreadyRegisteredException - Thrown if the specified role name already exists in the security system.

updateRole

void updateRole(Role role)
                throws SecurityManagerException

Update the informations for this role (actually, only the role name).

Parameters:

role - The role to update.

Throws:

SecurityManagerException - Thrown if the role cannot be updated into the security system.

deleteRole

void deleteRole(Role role)
                throws SecurityManagerException

Delete, on the security system, the specified role.

Parameters:

role - The role to delete.

Throws:

SecurityManagerException - Thrown if the specified role cannot be deleted from the seciry system.