|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.groups.ReferenceGroupService
Reference group service.
Method Summary | |
void |
deleteGroup(IEntityGroup group)
Removes the IEntityGroup from the cache and the store. |
void |
deleteGroup(ILockableEntityGroup group)
Removes the ILockableEntityGroup from the cache and the store. |
java.util.Iterator |
findContainingGroups(IGroupMember gm)
Returns and caches the containing groups for the IGroupMember |
IEntityGroup |
findGroup(java.lang.String key)
Returns a pre-existing IEntityGroup or null if it
does not exist. |
ILockableEntityGroup |
findGroupWithLock(java.lang.String key,
java.lang.String owner)
Returns a pre-existing ILockableEntityGroup or null if the
group is not found. |
ILockableEntityGroup |
findGroupWithLock(java.lang.String key,
java.lang.String owner,
int secs)
Returns a pre-existing ILockableEntityGroup or null if the
group is not found. |
java.util.Iterator |
findMemberGroups(IEntityGroup eg)
Returns and caches the member groups for the IEntityGroup |
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 . |
IEntity |
getEntity(java.lang.String key,
java.lang.Class type)
Returns an IEntity representing a portal entity. |
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 . |
IGroupMember |
getGroupMember(java.lang.String key,
java.lang.Class type)
Returns an IGroupMember representing either a group or a
portal entity. |
IEntityGroupStore |
getGroupStore()
Returns the implementation of IEntityGroupStore whose class name
was retrieved by the PropertiesManager (see initialize()). |
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 . |
IEntityGroup |
newGroup(java.lang.Class type)
Returns a new IEntityGroup for the given Class with an unused
key. |
EntityIdentifier[] |
searchForEntities(java.lang.String query,
int method,
java.lang.Class type)
Find EntityIdentifiers for entities whose name matches the query string according to the specified method and is of the specified type |
EntityIdentifier[] |
searchForEntities(java.lang.String query,
int method,
java.lang.Class type,
IEntityGroup ancestor)
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(java.lang.String query,
int method,
java.lang.Class leaftype)
Find EntityIdentifiers for groups whose name matches the query string according to the specified method and matches the provided leaf type |
EntityIdentifier[] |
searchForGroups(java.lang.String query,
int method,
java.lang.Class leaftype,
IEntityGroup ancestor)
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()
|
void |
updateGroup(IEntityGroup group)
Updates the cache and the store with the new IEntityGroup . |
void |
updateGroup(ILockableEntityGroup group)
Updates the ILockableEntityGroup in the cache and the store. |
void |
updateGroup(ILockableEntityGroup group,
boolean renewLock)
Updates the ILockableEntityGroup in the store and removes
it from the cache. |
void |
updateGroupMembers(IEntityGroup group)
Updates the cache and the store with the updated IEntityGroup . |
void |
updateGroupMembers(ILockableEntityGroup group)
Updates the ILockableEntityGroup in the cache and the store. |
void |
updateGroupMembers(ILockableEntityGroup group,
boolean renewLock)
Updates the ILockableEntityGroup in the store and removes
it from the cache. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void deleteGroup(IEntityGroup group) throws GroupsException
IEntityGroup
from the cache and the store.
deleteGroup
in interface IGroupService
group
- IEntityGroup
GroupsException
public void deleteGroup(ILockableEntityGroup group) throws GroupsException
ILockableEntityGroup
from the cache and the store.
deleteGroup
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public java.util.Iterator findContainingGroups(IGroupMember gm) throws GroupsException
IGroupMember
findContainingGroups
in interface IGroupService
gm
- IGroupMember
GroupsException
public IEntityGroup findGroup(java.lang.String key) throws GroupsException
IEntityGroup
or null if it
does not exist.
findGroup
in interface IGroupService
GroupsException
public ILockableEntityGroup findGroupWithLock(java.lang.String key, java.lang.String owner) throws GroupsException
ILockableEntityGroup
or null if the
group is not found.
findGroupWithLock
in interface ILockableGroupService
key
- String - the group key.owner
- String - the lock owner.
GroupsException
public ILockableEntityGroup findGroupWithLock(java.lang.String key, java.lang.String owner, int secs) throws GroupsException
ILockableEntityGroup
or null if the
group is not found.
findGroupWithLock
in interface ILockableGroupService
key
- String - the group key.owner
- String - the lock owner.secs
- int - the duration of the lock in seconds.
GroupsException
public java.util.Iterator findMemberGroups(IEntityGroup eg) throws GroupsException
IEntityGroup
findMemberGroups
in interface IGroupService
eg
- IEntityGroup
GroupsException
public IEntityGroup getDistinguishedGroup(java.lang.String name) throws GroupsException
IEntityGroup
.
GroupsException
public IEntity getEntity(java.lang.String key, java.lang.Class type) throws GroupsException
IEntity
representing a portal entity. This does
not guarantee that the entity actually exists.
getEntity
in interface IGroupService
GroupsException
public IGroupMember getGroupMember(EntityIdentifier underlyingEntityIdentifier) throws GroupsException
IGroupMember
representing either a group or a
portal entity, based on the EntityIdentifier
, which
refers to the UNDERLYING entity for the IGroupMember
.
getGroupMember
in interface IGroupService
GroupsException
public IGroupMember getGroupMember(java.lang.String key, java.lang.Class type) throws GroupsException
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
.
getGroupMember
in interface IGroupService
GroupsException
public IEntityGroupStore getGroupStore() throws GroupsException
IEntityGroupStore
whose class name
was retrieved by the PropertiesManager (see initialize()).
getGroupStore
in interface IGroupService
GroupsException
public IEntityGroup getRootGroup(java.lang.Class type) throws GroupsException
IEntityGroup
.
GroupsException
public IEntityGroup newGroup(java.lang.Class type) throws GroupsException
IEntityGroup
for the given Class with an unused
key.
newGroup
in interface IGroupService
GroupsException
public static IGroupService singleton() throws GroupsException
GroupsException
public void updateGroup(IEntityGroup group) throws GroupsException
IEntityGroup
.
updateGroup
in interface IGroupService
group
- IEntityGroup
GroupsException
public void updateGroup(ILockableEntityGroup group) throws GroupsException
ILockableEntityGroup
in the cache and the store.
updateGroup
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public void updateGroup(ILockableEntityGroup group, boolean renewLock) throws GroupsException
ILockableEntityGroup
in the store and removes
it from the cache.
updateGroup
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public void updateGroupMembers(IEntityGroup group) throws GroupsException
IEntityGroup
.
updateGroupMembers
in interface IGroupService
group
- IEntityGroup
GroupsException
public void updateGroupMembers(ILockableEntityGroup group) throws GroupsException
ILockableEntityGroup
in the cache and the store.
updateGroupMembers
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public void updateGroupMembers(ILockableEntityGroup group, boolean renewLock) throws GroupsException
ILockableEntityGroup
in the store and removes
it from the cache.
updateGroupMembers
in interface ILockableGroupService
group
- ILockableEntityGroup
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype) throws GroupsException
IGroupService
searchForGroups
in interface IGroupService
GroupsException
public EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype, IEntityGroup ancestor) throws GroupsException
IGroupService
searchForGroups
in interface IGroupService
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type) throws GroupsException
IGroupService
searchForEntities
in interface IGroupService
GroupsException
public EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type, IEntityGroup ancestor) throws GroupsException
IGroupService
searchForEntities
in interface IGroupService
GroupsException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |