org.jasig.portal.groups
Class ReferenceGroupService

java.lang.Object
  org.jasig.portal.groups.ReferenceGroupService

All Implemented Interfaces:

IGroupService, ILockableGroupService

Deprecated. Use instead an ICompositeGroupService implementation.

@Deprecated
public class ReferenceGroupService
extends Object
implements ILockableGroupService

Reference group service.

Version:

$Revision: 19776 $

Author:

Dan Ellentuck

Field Summary

protected IEntityStore	entityFactory Deprecated.
protected IEntitySearcher	entitySearcher Deprecated.
protected IEntityGroupStore	groupFactory Deprecated.
protected static IGroupService	singleton Deprecated.

Method Summary

protected void	addGroupToCache(IEntityGroup group) Deprecated.
protected boolean	cacheInUse() Deprecated. Answers if IGroupMembers are being cached.
void	deleteGroup(IEntityGroup group) Deprecated. Removes the IEntityGroup from the cache and the store.
void	deleteGroup(ILockableEntityGroup group) Deprecated. Removes the ILockableEntityGroup from the cache and the store.
Iterator	findContainingGroups(IGroupMember gm) Deprecated. Returns and caches the containing groups for the IGroupMember
IEntityGroup	findGroup(String key) Deprecated. Returns a pre-existing IEntityGroup or null if it does not exist.
protected IEntityGroup	findGroupWithCache(String key) Deprecated. Returns a pre-existing IEntityGroup or null if it does not exist.
ILockableEntityGroup	findGroupWithLock(String key, String owner) Deprecated. Returns a pre-existing ILockableEntityGroup or null if the group is not found.
ILockableEntityGroup	findGroupWithLock(String key, String owner, int secs) Deprecated. Returns a pre-existing ILockableEntityGroup or null if the group is not found.
Iterator	findMemberGroups(IEntityGroup eg) Deprecated. Returns and caches the member groups for the IEntityGroup
IEntityGroup	getDistinguishedGroup(String name) Deprecated. Refers to the PropertiesManager to get the key for the group associated with 'name' and asks the group store implementation for the corresponding IEntityGroup.
IEntity	getEntity(String key, Class type) Deprecated. Returns an IEntity representing a portal entity.
protected IEntityGroup	getGroupFromCache(String key) Deprecated. Returns a cached IEntityGroup or null if it has not been cached.
IGroupMember	getGroupMember(EntityIdentifier underlyingEntityIdentifier) Deprecated. Returns an IGroupMember representing either a group or a portal entity, based on the EntityIdentifier, which refers to the UNDERLYING entity for the IGroupMember.
IGroupMember	getGroupMember(String key, Class type) Deprecated. Returns an IGroupMember representing either a group or a portal entity.
IEntityGroupStore	getGroupStore() Deprecated. Returns the implementation of IEntityGroupStore whose class name was retrieved by the PropertiesManager (see initialize()).
IEntityGroup	getRootGroup(Class type) Deprecated. 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.
IEntityGroup	newGroup(Class type) Deprecated. Returns a new IEntityGroup for the given Class with an unused key.
protected void	removeGroupFromCache(IEntityGroup group) Deprecated.
EntityIdentifier[]	searchForEntities(String query, int method, Class type) Deprecated. Find EntityIdentifiers for entities whose name matches the query string according to the specified method and is of the specified type
EntityIdentifier[]	searchForEntities(String query, int method, Class type, IEntityGroup ancestor) Deprecated. Find EntityIdentifiers for entities whose name matches the query string according to the specified method, is of the specified type and descends from the specified group
EntityIdentifier[]	searchForGroups(String query, int method, Class leaftype) Deprecated. Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type
EntityIdentifier[]	searchForGroups(String query, int method, Class leaftype, IEntityGroup ancestor) Deprecated. Find EntityIdentifiers for groups whose name matches the query string according to the specified method, has the provided leaf type and descends from the specified group
static IGroupService	singleton() Deprecated.
void	updateGroup(IEntityGroup group) Deprecated. Updates the cache and the store with the new IEntityGroup.
void	updateGroup(ILockableEntityGroup group) Deprecated. Updates the ILockableEntityGroup in the cache and the store.
void	updateGroup(ILockableEntityGroup group, boolean renewLock) Deprecated. Updates the ILockableEntityGroup in the store and removes it from the cache.
protected void	updateGroupInCache(IEntityGroup group) Deprecated.
void	updateGroupMembers(IEntityGroup group) Deprecated. Updates the cache and the store with the updated IEntityGroup.
void	updateGroupMembers(ILockableEntityGroup group) Deprecated. Updates the ILockableEntityGroup in the cache and the store.
void	updateGroupMembers(ILockableEntityGroup group, boolean renewLock) Deprecated. Updates the ILockableEntityGroup in the store and removes it from the cache.

Methods inherited from class java.lang.Object

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

Field Detail

singleton

protected static IGroupService singleton

Deprecated.

entityFactory

protected IEntityStore entityFactory

Deprecated.

groupFactory

protected IEntityGroupStore groupFactory

Deprecated.

entitySearcher

protected IEntitySearcher entitySearcher

Deprecated.

Method Detail

addGroupToCache

protected void addGroupToCache(IEntityGroup group)
                        throws CachingException

Deprecated.

Throws:

CachingException

cacheInUse

protected boolean cacheInUse()

Deprecated.

Answers if IGroupMembers are being cached.

deleteGroup

public void deleteGroup(IEntityGroup group)
                 throws GroupsException

Deprecated.

Removes the IEntityGroup from the cache and the store.

Specified by:

deleteGroup in interface IGroupService

Parameters:

group - IEntityGroup

Throws:

GroupsException

deleteGroup

public void deleteGroup(ILockableEntityGroup group)
                 throws GroupsException

Deprecated.

Removes the ILockableEntityGroup from the cache and the store.

Specified by:

deleteGroup in interface ILockableGroupService

Parameters:

group - ILockableEntityGroup

Throws:

GroupsException

findContainingGroups

public Iterator findContainingGroups(IGroupMember gm)
                              throws GroupsException

Deprecated.

Returns and caches the containing groups for the IGroupMember

Specified by:

findContainingGroups in interface IGroupService

Parameters:

gm - IGroupMember

Throws:

GroupsException

findGroup

public IEntityGroup findGroup(String key)
                       throws GroupsException

Deprecated.

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

Specified by:

findGroup in interface IGroupService

Throws:

GroupsException

findGroupWithCache

protected IEntityGroup findGroupWithCache(String key)
                                   throws GroupsException

Deprecated.

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

Throws:

GroupsException

findGroupWithLock

public ILockableEntityGroup findGroupWithLock(String key,
                                              String owner)
                                       throws GroupsException

Deprecated.

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

Specified by:

findGroupWithLock in interface ILockableGroupService

Parameters:

key - String - the group key.

owner - String - the lock owner.

Returns:

org.jasig.portal.groups.ILockableEntityGroup

Throws:

GroupsException

findGroupWithLock

public ILockableEntityGroup findGroupWithLock(String key,
                                              String owner,
                                              int secs)
                                       throws GroupsException

Deprecated.

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

Specified by:

findGroupWithLock in interface ILockableGroupService

Parameters:

key - String - the group key.

owner - String - the lock owner.

secs - int - the duration of the lock in seconds.

Returns:

org.jasig.portal.groups.ILockableEntityGroup

Throws:

GroupsException

findMemberGroups

public Iterator findMemberGroups(IEntityGroup eg)
                          throws GroupsException

Deprecated.

Returns and caches the member groups for the IEntityGroup

Specified by:

findMemberGroups in interface IGroupService

Parameters:

eg - IEntityGroup

Throws:

GroupsException

getDistinguishedGroup

public IEntityGroup getDistinguishedGroup(String name)
                                   throws GroupsException

Deprecated.

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

getEntity

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

Deprecated.

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

Specified by:

getEntity in interface IGroupService

Throws:

GroupsException

getGroupFromCache

protected IEntityGroup getGroupFromCache(String key)
                                  throws CachingException

Deprecated.

Returns a cached IEntityGroup or null if it has not been cached.

Throws:

CachingException

getGroupMember

public IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier)
                            throws GroupsException

Deprecated.

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

Specified by:

getGroupMember in interface IGroupService

Throws:

GroupsException

getGroupMember

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

Deprecated.

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.

Specified by:

getGroupMember in interface IGroupService

Throws:

GroupsException

getGroupStore

public IEntityGroupStore getGroupStore()
                                throws GroupsException

Deprecated.

Returns the implementation of IEntityGroupStore whose class name was retrieved by the PropertiesManager (see initialize()).

Specified by:

getGroupStore in interface IGroupService

Throws:

GroupsException

getRootGroup

public IEntityGroup getRootGroup(Class type)
                          throws GroupsException

Deprecated.

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

newGroup

public IEntityGroup newGroup(Class type)
                      throws GroupsException

Deprecated.

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

Specified by:

newGroup in interface IGroupService

Throws:

GroupsException

removeGroupFromCache

protected void removeGroupFromCache(IEntityGroup group)
                             throws CachingException

Deprecated.

Throws:

CachingException

singleton

public static IGroupService singleton()
                               throws GroupsException

Deprecated.

Returns:

org.jasig.portal.groups.IGroupService

Throws:

GroupsException

updateGroup

public void updateGroup(IEntityGroup group)
                 throws GroupsException

Deprecated.

Updates the cache and the store with the new IEntityGroup.

Specified by:

updateGroup in interface IGroupService

Parameters:

group - IEntityGroup

Throws:

GroupsException

updateGroup

public void updateGroup(ILockableEntityGroup group)
                 throws GroupsException

Deprecated.

Updates the ILockableEntityGroup in the cache and the store.

Specified by:

updateGroup in interface ILockableGroupService

Parameters:

group - ILockableEntityGroup

Throws:

GroupsException

updateGroup

public void updateGroup(ILockableEntityGroup group,
                        boolean renewLock)
                 throws GroupsException

Deprecated.

Updates the ILockableEntityGroup in the store and removes it from the cache.

Specified by:

updateGroup in interface ILockableGroupService

Parameters:

group - ILockableEntityGroup

Throws:

GroupsException

updateGroupInCache

protected void updateGroupInCache(IEntityGroup group)
                           throws CachingException

Deprecated.

Throws:

CachingException

updateGroupMembers

public void updateGroupMembers(IEntityGroup group)
                        throws GroupsException

Deprecated.

Updates the cache and the store with the updated IEntityGroup.

Specified by:

updateGroupMembers in interface IGroupService

Parameters:

group - IEntityGroup

Throws:

GroupsException

updateGroupMembers

public void updateGroupMembers(ILockableEntityGroup group)
                        throws GroupsException

Deprecated.

Updates the ILockableEntityGroup in the cache and the store.

Specified by:

updateGroupMembers in interface ILockableGroupService

Parameters:

group - ILockableEntityGroup

Throws:

GroupsException

updateGroupMembers

public void updateGroupMembers(ILockableEntityGroup group,
                               boolean renewLock)
                        throws GroupsException

Deprecated.

Updates the ILockableEntityGroup in the store and removes it from the cache.

Specified by:

updateGroupMembers in interface ILockableGroupService

Parameters:

group - ILockableEntityGroup

Throws:

GroupsException

searchForGroups

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

Deprecated.

Description copied from interface: IGroupService

Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type

Specified by:

searchForGroups in interface IGroupService

Throws:

GroupsException

searchForGroups

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

Deprecated.

Description copied from interface: IGroupService

Find EntityIdentifiers for groups whose name matches the query string according to the specified method, has the provided leaf type and descends from the specified group

Specified by:

searchForGroups in interface IGroupService

Throws:

GroupsException

searchForEntities

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

Deprecated.

Description copied from interface: IGroupService

Find EntityIdentifiers for entities whose name matches the query string according to the specified method and is of the specified type

Specified by:

searchForEntities in interface IGroupService

Throws:

GroupsException

searchForEntities

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

Deprecated.

Description copied from interface: IGroupService

Find EntityIdentifiers for entities whose name matches the query string according to the specified method, is of the specified type and descends from the specified group

Specified by:

searchForEntities in interface IGroupService

Throws:

GroupsException