org.apache.jetspeed.security.spi
Interface RoleSecurityHandler

All Known Implementing Classes:
DefaultRoleSecurityHandler

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
 Principal 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(org.apache.jetspeed.security.RolePrincipal rolePrincipal)
           Removes the role principal.
 void setRolePrincipal(org.apache.jetspeed.security.RolePrincipal rolePrincipal)
           Sets the role principal in the backing store.
 

Method Detail

getRolePrincipal

public Principal 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

public void setRolePrincipal(org.apache.jetspeed.security.RolePrincipal rolePrincipal)
                      throws org.apache.jetspeed.security.SecurityException

Sets the role principal in the backing store.

Parameters:
rolePrincipal - The RolePrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

removeRolePrincipal

public void removeRolePrincipal(org.apache.jetspeed.security.RolePrincipal rolePrincipal)
                         throws org.apache.jetspeed.security.SecurityException

Removes the role principal.

Parameters:
rolePrincipal - The RolePrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

getRolePrincipals

public List getRolePrincipals(String filter)

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

Parameters:
filter - The filter.
Returns:
The list of Principal


Copyright © 1999-2005 Apache Software Foundation. All Rights Reserved.