org.jasig.portal.services
Class GroupService

java.lang.Object
  org.jasig.portal.services.GroupService

All Implemented Interfaces:

IGroupConstants

public class GroupService
extends Object
implements IGroupConstants

Bootstrap class for the IGroupService implementation.

Version:

$Revision: 19776 $

Author:

Alex Vigdor, Dan Ellentuck

Field Summary

protected static String

GROUP_SERVICE_KEY

Fields inherited from interface org.jasig.portal.groups.IGroupConstants

CHANNEL_CATEGORIES, CONTAINS, ENDS_WITH, EVERYONE, IS, NODE_SEPARATOR, PORTAL_ADMINISTRATORS, STARTS_WITH

Method Summary

static IEntityGroup	findGroup(String key) Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.
static ILockableEntityGroup	findLockableGroup(String key, String lockOwner) Returns a pre-existing ILockableEntityGroup or null if the group is not found.
static void	finishedSession(IPerson person) Receives notice that the UserInstance has been unbound from the HttpSession.
static ICompositeGroupService	getCompositeGroupService() Returns the ICompositeGroupService implementation in use.
protected String	getDefaultServiceName()
static IEntityGroup	getDistinguishedGroup(String name) Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.
String	getDistinguishedGroupKey(String name)
static IEntity	getEntity(String key, Class type) Returns an IEntity representing a portal entity.
static IEntity	getEntity(String key, Class type, String service) Returns an IEntity representing a portal entity.
static IGroupMember	getGroupMember(EntityIdentifier underlyingEntityIdentifier) Returns an IGroupMember representing either a group or a portal entity, based on the EntityIdentifier, which refers to the UNDERLYING entity for the IGroupMember.
static IGroupMember	getGroupMember(String key, Class type) Returns an IGroupMember representing either a group or a portal entity.
static IGroupService	getGroupService() Returns the IGroupService implementation in use.
static IEntityGroup	getRootGroup(Class type) Refers to the PropertiesManager to get the key for the root group associated with 'type' and asks the group store implementation for the corresponding IEntityGroup.
protected GroupServiceConfiguration	getServiceConfiguration()
protected IEntityGroup	ifindGroup(String key) Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.
protected ILockableEntityGroup	ifindLockableGroup(String key, String lockOwner) Returns a pre-existing ILockableEntityGroup or null if the group is not found.
protected void	ifinishedSession(IPerson person) Receives notice that the UserInstance has been unbound from the HttpSession.
protected IEntityGroup	igetDistinguishedGroup(String name) Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.
protected IEntity	igetEntity(String key, Class type, String service) Returns an IEntity representing a pre-existing portal entity.
protected IGroupMember	igetGroupMember(String key, Class type) Returns an IGroupMember representing either a group or a portal entity.
protected IEntityGroup	igetRootGroup(Class type) Refers to the PropertiesManager to get the key for the root group associated with 'type' and asks the group store implementation for the corresponding IEntityGroup.
protected IEntityGroup	inewGroup(Class type) Returns a new IEntityGroup for the given Class with an unused key.
protected IEntityGroup	inewGroup(Class type, String serviceName) Returns a new IEntityGroup for the given Class with an unused key.
static GroupService	instance()
static boolean	isComposite() Answer if the underlying group service is a composite service, implementing ICompositeGroupService.
static IEntityGroup	newGroup(Class type) Returns a new IEntityGroup for the given Class with an unused key.
static IEntityGroup	newGroup(Class type, String serviceName) Returns a new IEntityGroup for the given Class with an unused key.
static String	parseLocalKey(String compositeKey) Extracts the final node from the String form of a composite key.
static Name	parseServiceName(String serviceName) Converts the String form of a service name into a Name.
static EntityIdentifier[]	searchForEntities(String query, int method, Class type)
static EntityIdentifier[]	searchForEntities(String query, int method, Class type, IEntityGroup ancestor)
static EntityIdentifier[]	searchForGroups(String query, int method, Class leaftype)
static EntityIdentifier[]	searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor)
static void	startUp()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GROUP_SERVICE_KEY

protected static final String GROUP_SERVICE_KEY

See Also:

Constant Field Values

Method Detail

findGroup

public static IEntityGroup findGroup(String key)
                              throws GroupsException

Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.

Parameters:

key - String - the group key.

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

findLockableGroup

public static ILockableEntityGroup findLockableGroup(String key,
                                                     String lockOwner)
                                              throws GroupsException

Returns a pre-existing ILockableEntityGroup or null if the group is not found.

Parameters:

key - String - the group key.

lockOwner - String - the owner of the lock, typically the user.

Returns:

org.jasig.portal.groups.ILockableEntityGroup

Throws:

GroupsException

finishedSession

public static void finishedSession(IPerson person)

Receives notice that the UserInstance has been unbound from the HttpSession. In response, we remove the corresponding group member from the cache.

Parameters:

person - org.jasig.portal.security.IPerson

getCompositeGroupService

public static ICompositeGroupService getCompositeGroupService()
                                                       throws GroupsException

Returns the ICompositeGroupService implementation in use.

Returns:

org.jasig.portal.groups.ICompositeGroupService

Throws:

GroupsException

getDefaultServiceName

protected String getDefaultServiceName()
                                throws GroupsException

Returns:

java.lang.String

Throws:

GroupsException

getDistinguishedGroup

public static IEntityGroup getDistinguishedGroup(String name)
                                          throws GroupsException

Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.

Throws:

GroupsException

getDistinguishedGroupKey

public String getDistinguishedGroupKey(String name)

Returns:

java.lang.String

getEntity

public static IEntity getEntity(String key,
                                Class type)
                         throws GroupsException

Returns an IEntity representing a portal entity. This does not guarantee that the entity actually exists.

Parameters:

key - String - the group key.

type - Class - the Class of the underlying IGroupMember.

Returns:

org.jasig.portal.groups.IEntity

Throws:

GroupsException

getEntity

public static IEntity getEntity(String key,
                                Class type,
                                String service)
                         throws GroupsException

Returns an IEntity representing a portal entity. This does not guarantee that the entity actually exists.

Parameters:

key - String - the group key.

type - Class - the Class of the underlying IGroupMember.

service - String - the name of the component service.

Returns:

org.jasig.portal.groups.IEntity

Throws:

GroupsException

getGroupMember

public static IGroupMember getGroupMember(String key,
                                          Class type)
                                   throws GroupsException

Returns an IGroupMember representing either a group or a portal entity. If the parm type is the group type, the IGroupMember is an IEntityGroup else it is an IEntity .

Throws:

GroupsException

getGroupMember

public static IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier)
                                   throws GroupsException

Returns an IGroupMember representing either a group or a portal entity, based on the EntityIdentifier, which refers to the UNDERLYING entity for the IGroupMember.

Throws:

GroupsException

getGroupService

public static IGroupService getGroupService()
                                     throws GroupsException

Returns the IGroupService implementation in use.

Returns:

org.jasig.portal.groups.IGroupService

Throws:

GroupsException

getRootGroup

public static IEntityGroup getRootGroup(Class type)
                                 throws GroupsException

Refers to the PropertiesManager to get the key for the root group associated with 'type' and asks the group store implementation for the corresponding IEntityGroup.

Throws:

GroupsException

getServiceConfiguration

protected GroupServiceConfiguration getServiceConfiguration()
                                                     throws GroupsException

Returns:

java.lang.String

Throws:

GroupsException

ifindGroup

protected IEntityGroup ifindGroup(String key)
                           throws GroupsException

Returns a pre-existing IEntityGroup or null if the IGroupMember does not exist.

Parameters:

key - String - the group key.

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

ifindLockableGroup

protected ILockableEntityGroup ifindLockableGroup(String key,
                                                  String lockOwner)
                                           throws GroupsException

Returns a pre-existing ILockableEntityGroup or null if the group is not found.

Parameters:

key - String - the group key.

lockOwner - String - typically the user.

Returns:

org.jasig.portal.groups.ILockableEntityGroup

Throws:

GroupsException

ifinishedSession

protected void ifinishedSession(IPerson person)
                         throws GroupsException

Receives notice that the UserInstance has been unbound from the HttpSession. In response, we remove the corresponding group member from the cache. We use the roundabout route of creating a group member and then getting its EntityIdentifier because we need the EntityIdentifier for the group member, which is cached, not the EntityIdentifier for the IPerson, which is not.

Parameters:

person - org.jasig.portal.security.IPerson

Throws:

GroupsException

igetDistinguishedGroup

protected IEntityGroup igetDistinguishedGroup(String name)
                                       throws GroupsException

Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.

Throws:

GroupsException

igetEntity

protected IEntity igetEntity(String key,
                             Class type,
                             String service)
                      throws GroupsException

Returns an IEntity representing a pre-existing portal entity.

Parameters:

key - String - the group key.

type - Class - the Class of the underlying IGroupMember.

Returns:

org.jasig.portal.groups.IEntity

Throws:

GroupsException

igetGroupMember

protected IGroupMember igetGroupMember(String key,
                                       Class type)
                                throws GroupsException

Returns an IGroupMember representing either a group or a portal entity. If the parm type is the group type, the IGroupMember is an IEntityGroup else it is an IEntity.

Throws:

GroupsException

igetRootGroup

protected IEntityGroup igetRootGroup(Class type)
                              throws GroupsException

Refers to the PropertiesManager to get the key for the root group associated with 'type' and asks the group store implementation for the corresponding IEntityGroup.

Throws:

GroupsException

inewGroup

protected IEntityGroup inewGroup(Class type)
                          throws GroupsException

Returns a new IEntityGroup for the given Class with an unused key.

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

inewGroup

protected IEntityGroup inewGroup(Class type,
                                 String serviceName)
                          throws GroupsException

Returns a new IEntityGroup for the given Class with an unused key.

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

instance

public static GroupService instance()
                             throws GroupsException

Throws:

GroupsException

isComposite

public static boolean isComposite()

Answer if the underlying group service is a composite service, implementing ICompositeGroupService.

newGroup

public static IEntityGroup newGroup(Class type)
                             throws GroupsException

Returns a new IEntityGroup for the given Class with an unused key.

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

newGroup

public static IEntityGroup newGroup(Class type,
                                    String serviceName)
                             throws GroupsException

Returns a new IEntityGroup for the given Class with an unused key.

Returns:

org.jasig.portal.groups.IEntityGroup

Throws:

GroupsException

parseLocalKey

public static String parseLocalKey(String compositeKey)
                            throws InvalidNameException,
                                   GroupsException

Extracts the final node from the String form of a composite key.

Returns:

String

Throws:

InvalidNameException

GroupsException

parseServiceName

public static Name parseServiceName(String serviceName)
                             throws InvalidNameException,
                                    GroupsException

Converts the String form of a service name into a Name.

Returns:

javax.naming.Name

Throws:

InvalidNameException

GroupsException

searchForEntities

public static EntityIdentifier[] searchForEntities(String query,
                                                   int method,
                                                   Class type)
                                            throws GroupsException

Throws:

GroupsException

searchForEntities

public static EntityIdentifier[] searchForEntities(String query,
                                                   int method,
                                                   Class type,
                                                   IEntityGroup ancestor)
                                            throws GroupsException

Throws:

GroupsException

searchForGroups

public static EntityIdentifier[] searchForGroups(String query,
                                                 int method,
                                                 Class leaftype)
                                          throws GroupsException

Throws:

GroupsException

searchForGroups

public static EntityIdentifier[] searchForGroups(String query,
                                                 int method,
                                                 Class leaftype,
                                                 IEntityGroup ancestor)
                                          throws GroupsException

Throws:

GroupsException

startUp

public static void startUp()
                    throws GroupsException

Throws:

GroupsException