org.apache.jetspeed.security.spi
Interface GroupSecurityHandler

All Known Implementing Classes:
DefaultGroupSecurityHandler, LdapGroupSecurityHandler

public interface GroupSecurityHandler

This interface encapsulates the persistence of security groups.

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

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

Author:
David Le Strat

Method Summary
 Principal getGroupPrincipal(String groupFullPathName)
           Gets the group principal for the group full path name {principal}.{subprincipal}.
 List getGroupPrincipals(String filter)
           Gets the an iterator of group principals for a given filter.
 void removeGroupPrincipal(org.apache.jetspeed.security.GroupPrincipal groupPrincipal)
           Removes the group principal.
 void setGroupPrincipal(org.apache.jetspeed.security.GroupPrincipal groupPrincipal)
           Sets the group principal in the backing store.
 

Method Detail

getGroupPrincipal

public Principal getGroupPrincipal(String groupFullPathName)

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

Parameters:
groupFullPathName - The group full path name.
Returns:
The Principal


setGroupPrincipal

public void setGroupPrincipal(org.apache.jetspeed.security.GroupPrincipal groupPrincipal)
                       throws org.apache.jetspeed.security.SecurityException

Sets the group principal in the backing store.

Parameters:
groupPrincipal - The GroupPrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

removeGroupPrincipal

public void removeGroupPrincipal(org.apache.jetspeed.security.GroupPrincipal groupPrincipal)
                          throws org.apache.jetspeed.security.SecurityException

Removes the group principal.

Parameters:
groupPrincipal - The GroupPrincipal.
Throws:
org.apache.jetspeed.security.SecurityException - Throws a SecurityException.

getGroupPrincipals

public List getGroupPrincipals(String filter)

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

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


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