org.apache.jetspeed.services.security.nosecurity
Class NoGroupManagement

java.lang.Object
  extended byorg.apache.turbine.services.BaseInitable
      extended byorg.apache.turbine.services.BaseService
          extended byorg.apache.turbine.services.TurbineBaseService
              extended byorg.apache.jetspeed.services.security.nosecurity.NoGroupManagement
All Implemented Interfaces:
GroupManagement, org.apache.turbine.services.Initable, org.apache.turbine.services.Service

public class NoGroupManagement
extends org.apache.turbine.services.TurbineBaseService
implements GroupManagement

The NoGroupManagement class is a Jetspeed security provider, implementing the GroupManagement interface. It provides no group management - no groups are listed, no groups are saved, no users are in any groups, any request for a group is satisfied with a temporary Group object.

Version:
$Id: NoGroupManagement.java,v 1.3 2004/02/23 03:53:24 jford Exp $
Author:
Glenn R. Golden

Field Summary
 
Fields inherited from class org.apache.turbine.services.BaseService
configuration, name, properties, serviceBroker
 
Fields inherited from class org.apache.turbine.services.BaseInitable
initableBroker, isInitialized
 
Fields inherited from interface org.apache.jetspeed.services.security.GroupManagement
DEFAULT_GROUP_NAME, SERVICE_NAME
 
Constructor Summary
NoGroupManagement()
           
 
Method Summary
 void addGroup(Group group)
          Adds a Group into permanent storage.
 Group getGroup(java.lang.String groupname)
          Retrieves a single Group for a given groupname principal.
 java.util.Iterator getGroups()
          Retrieves all Groups.
 java.util.Iterator getGroups(java.lang.String username)
          Retrieves all Groups for a given username principal.
 java.util.HashMap getTurbineGroupRole(java.lang.String username)
          Retrieves a hashtable which associates Groups with Roles for a given username principal.
 boolean inGroup(java.lang.String username, java.lang.String groupname)
          Checks for the relationship of user in a group.
 void joinGroup(java.lang.String username, java.lang.String groupname)
          Joins a user to a group.
 void joinGroup(java.lang.String username, java.lang.String groupname, java.lang.String rolename)
          Join a user to a group - specific role.
 void removeGroup(java.lang.String groupname)
          Removes a Group from the permanent store.
 void saveGroup(Group group)
          Saves a Group into permanent storage.
 void unjoinGroup(java.lang.String username, java.lang.String groupname)
          Unjoins a user from a group.
 void unjoinGroup(java.lang.String username, java.lang.String groupname, java.lang.String rolename)
          Unjoin a user from a group in which the user has a specific role instead of JetspeedSecurity.getRole(defaultRole) The security service may optionally check the current user context to determine if the requestor has permission to perform this action.
 
Methods inherited from class org.apache.turbine.services.TurbineBaseService
init, init, init, init, shutdown
 
Methods inherited from class org.apache.turbine.services.BaseService
getConfiguration, getName, getProperties, getServiceBroker, setName, setServiceBroker
 
Methods inherited from class org.apache.turbine.services.BaseInitable
getInit, getInitableBroker, setInit, setInitableBroker
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.turbine.services.Service
getConfiguration, getName, getProperties, setName, setServiceBroker
 
Methods inherited from interface org.apache.turbine.services.Initable
getInit, init, init, setInitableBroker, shutdown
 

Constructor Detail

NoGroupManagement

public NoGroupManagement()
Method Detail

getGroups

public java.util.Iterator getGroups(java.lang.String username)
                             throws JetspeedSecurityException
Retrieves all Groups for a given username principal. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
getGroups in interface GroupManagement
Parameters:
username - a user principal identity to be retrieved.
Returns:
Iterator over all groups associated to the user principal.
Throws:
GroupException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

getGroups

public java.util.Iterator getGroups()
                             throws JetspeedSecurityException
Retrieves all Groups. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
getGroups in interface GroupManagement
Returns:
Iterator over all groups.
Throws:
GroupException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

addGroup

public void addGroup(Group group)
              throws JetspeedSecurityException
Adds a Group into permanent storage. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
addGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

saveGroup

public void saveGroup(Group group)
               throws JetspeedSecurityException
Saves a Group into permanent storage. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
saveGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

removeGroup

public void removeGroup(java.lang.String groupname)
                 throws JetspeedSecurityException
Removes a Group from the permanent store. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
removeGroup in interface GroupManagement
Parameters:
groupname - the principal identity of the group to be retrieved.
Throws:
GroupException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

joinGroup

public void joinGroup(java.lang.String username,
                      java.lang.String groupname)
               throws JetspeedSecurityException
Joins a user to a group. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
joinGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure retrieving groups.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

joinGroup

public void joinGroup(java.lang.String username,
                      java.lang.String groupname,
                      java.lang.String rolename)
               throws JetspeedSecurityException
Join a user to a group - specific role. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
joinGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure retrieving groups.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

unjoinGroup

public void unjoinGroup(java.lang.String username,
                        java.lang.String groupname)
                 throws JetspeedSecurityException
Unjoins a user from a group. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
unjoinGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure retrieving groups.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

unjoinGroup

public void unjoinGroup(java.lang.String username,
                        java.lang.String groupname,
                        java.lang.String rolename)
                 throws JetspeedSecurityException
Unjoin a user from a group in which the user has a specific role instead of JetspeedSecurity.getRole(defaultRole) The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
unjoinGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure retrieving groups.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

inGroup

public boolean inGroup(java.lang.String username,
                       java.lang.String groupname)
                throws JetspeedSecurityException
Checks for the relationship of user in a group. Returns true when the user is in the given group. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
inGroup in interface GroupManagement
Throws:
GroupException - when the security provider has a general failure retrieving groups.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

getGroup

public Group getGroup(java.lang.String groupname)
               throws JetspeedSecurityException
Retrieves a single Group for a given groupname principal. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Specified by:
getGroup in interface GroupManagement
Parameters:
groupname - a group principal identity to be retrieved.
Returns:
Group the group record retrieved.
Throws:
GroupException - when the security provider has a general failure.
InsufficientPrivilegeException - when the requestor is denied due to insufficient privilege
JetspeedSecurityException

getTurbineGroupRole

public java.util.HashMap getTurbineGroupRole(java.lang.String username)
                                      throws JetspeedSecurityException
Retrieves a hashtable which associates Groups with Roles for a given username principal. The security service may optionally check the current user context to determine if the requestor has permission to perform this action.

Parameters:
username - a user principal identity to be retrieved.
Returns:
Hashtable record retrieved.
Throws:
GroupException - when the security provider has a general failure.
JetspeedSecurityException


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