uPortal 2.4.1
API Documentation

org.jasig.portal.services
Class GroupService

java.lang.Object
  extended byorg.jasig.portal.services.GroupService
All Implemented Interfaces:
IGroupConstants

public class GroupService
extends java.lang.Object
implements IGroupConstants

Bootstrap class for the IGroupService implementation.

Version:
$Revision: 1.21.2.1 $
Author:
Alex Vigdor, Dan Ellentuck

Field Summary
 
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(java.lang.String key)
           
static ILockableEntityGroup findLockableGroup(java.lang.String key, java.lang.String lockOwner)
           
static void finishedSession(IPerson person)
          Receives notice that the UserInstance has been unbound from the HttpSession.
static ICompositeGroupService getCompositeGroupService()
           
static IEntityGroup getDistinguishedGroup(java.lang.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.
 java.lang.String getDistinguishedGroupKey(java.lang.String name)
           
static IEntity getEntity(java.lang.String key, java.lang.Class type)
           
static IEntity getEntity(java.lang.String key, java.lang.Class type, java.lang.String service)
           
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(java.lang.String key, java.lang.Class type)
           
static IGroupService getGroupService()
           
static IEntityGroup getRootGroup(java.lang.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.
static GroupService instance()
           
static boolean isComposite()
           
static IEntityGroup newGroup(java.lang.Class type)
          Returns a new IEntityGroup for the given Class with an unused key.
static IEntityGroup newGroup(java.lang.Class type, java.lang.String serviceName)
          Returns a new IEntityGroup for the given Class with an unused key.
static java.lang.String parseLocalKey(java.lang.String compositeKey)
          Extracts the final node from the String form of a composite key.
static javax.naming.Name parseServiceName(java.lang.String serviceName)
          Converts the String form of a service name into a Name.
static EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type)
           
static EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type, IEntityGroup ancestor)
           
static EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype)
           
static EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype, IEntityGroup ancestor)
           
static void startUp()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

findGroup

public static IEntityGroup findGroup(java.lang.String key)
                              throws GroupsException
Throws:
GroupsException

findLockableGroup

public static ILockableEntityGroup findLockableGroup(java.lang.String key,
                                                     java.lang.String lockOwner)
                                              throws GroupsException
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
Throws:
GroupsException

getDistinguishedGroup

public static IEntityGroup getDistinguishedGroup(java.lang.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 java.lang.String getDistinguishedGroupKey(java.lang.String name)
Returns:
java.lang.String

getEntity

public static IEntity getEntity(java.lang.String key,
                                java.lang.Class type)
                         throws GroupsException
Throws:
GroupsException

getEntity

public static IEntity getEntity(java.lang.String key,
                                java.lang.Class type,
                                java.lang.String service)
                         throws GroupsException
Throws:
GroupsException

getGroupMember

public static IGroupMember getGroupMember(java.lang.String key,
                                          java.lang.Class type)
                                   throws GroupsException
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
Throws:
GroupsException

getRootGroup

public static IEntityGroup getRootGroup(java.lang.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

instance

public static GroupService instance()
                             throws GroupsException
Throws:
GroupsException

isComposite

public static boolean isComposite()

newGroup

public static IEntityGroup newGroup(java.lang.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(java.lang.Class type,
                                    java.lang.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 java.lang.String parseLocalKey(java.lang.String compositeKey)
                                      throws javax.naming.InvalidNameException,
                                             GroupsException
Extracts the final node from the String form of a composite key.

Returns:
String
Throws:
javax.naming.InvalidNameException
GroupsException

parseServiceName

public static javax.naming.Name parseServiceName(java.lang.String serviceName)
                                          throws javax.naming.InvalidNameException,
                                                 GroupsException
Converts the String form of a service name into a Name.

Returns:
javax.naming.Name
Throws:
javax.naming.InvalidNameException
GroupsException

searchForEntities

public static EntityIdentifier[] searchForEntities(java.lang.String query,
                                                   int method,
                                                   java.lang.Class type)
                                            throws GroupsException
Throws:
GroupsException

searchForEntities

public static EntityIdentifier[] searchForEntities(java.lang.String query,
                                                   int method,
                                                   java.lang.Class type,
                                                   IEntityGroup ancestor)
                                            throws GroupsException
Throws:
GroupsException

searchForGroups

public static EntityIdentifier[] searchForGroups(java.lang.String query,
                                                 int method,
                                                 java.lang.Class leaftype)
                                          throws GroupsException
Throws:
GroupsException

searchForGroups

public static EntityIdentifier[] searchForGroups(java.lang.String query,
                                                 int method,
                                                 java.lang.Class leaftype,
                                                 IEntityGroup ancestor)
                                          throws GroupsException
Throws:
GroupsException

startUp

public static void startUp()
                    throws GroupsException
Throws:
GroupsException

uPortal 2.4.1
API Documentation