org.apache.jetspeed.security.spi
Interface RoleSecurityHandler

public interface RoleSecurityHandler

This interface encapsulates the persistence of security roles.

This provides a central placeholder for changing the persistence of roles security information.

A security implementation wanting to store role security implementation in LDAP for instance would need to provide an LDAP implementation of this interface.

Author:

David Le Strat

Method Summary

RolePrincipal	getRolePrincipal(String roleFullPathName) Gets the role principal for the role full path name {principal}.{subprincipal}.
List	getRolePrincipals(String filter) Gets the an iterator of role principals for a given filter.
void	removeRolePrincipal(RolePrincipal rolePrincipal) Removes the role principal.
void	setRolePrincipal(RolePrincipal rolePrincipal) Sets the role principal in the backing store.

Method Detail

getRolePrincipal

RolePrincipal getRolePrincipal(String roleFullPathName)

Gets the role principal for the role full path name {principal}.{subprincipal}.

Parameters:

roleFullPathName - The role full path name.

Returns:

The Principal

setRolePrincipal

void setRolePrincipal(RolePrincipal rolePrincipal)
                      throws SecurityException

Sets the role principal in the backing store.

Parameters:

rolePrincipal - The RolePrincipal.

Throws:

SecurityException - Throws a SecurityException.

removeRolePrincipal

void removeRolePrincipal(RolePrincipal rolePrincipal)
                         throws SecurityException

Removes the role principal.

Parameters:

rolePrincipal - The RolePrincipal.

Throws:

SecurityException - Throws a SecurityException.

getRolePrincipals

List getRolePrincipals(String filter)

Gets the an iterator of role principals for a given filter.

Parameters:

filter - The filter.

Returns:

The list of Principal