|
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.services.GroupService
Bootstrap class for the IGroupService implementation.
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 |
public static IEntityGroup findGroup(java.lang.String key) throws GroupsException
GroupsException
public static ILockableEntityGroup findLockableGroup(java.lang.String key, java.lang.String lockOwner) throws GroupsException
GroupsException
public static void finishedSession(IPerson person)
person
- org.jasig.portal.security.IPersonpublic static ICompositeGroupService getCompositeGroupService() throws GroupsException
GroupsException
public static IEntityGroup getDistinguishedGroup(java.lang.String name) throws GroupsException
IEntityGroup
.
GroupsException
public java.lang.String getDistinguishedGroupKey(java.lang.String name)
public static IEntity getEntity(java.lang.String key, java.lang.Class type) throws GroupsException
GroupsException
public static IEntity getEntity(java.lang.String key, java.lang.Class type, java.lang.String service) throws GroupsException
GroupsException
public static IGroupMember getGroupMember(java.lang.String key, java.lang.Class type) throws GroupsException
GroupsException
public static 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
.
GroupsException
public static IGroupService getGroupService() throws GroupsException
GroupsException
public static IEntityGroup getRootGroup(java.lang.Class type) throws GroupsException
IEntityGroup
.
GroupsException
public static GroupService instance() throws GroupsException
GroupsException
public static boolean isComposite()
public static IEntityGroup newGroup(java.lang.Class type) throws GroupsException
IEntityGroup
for the given Class with an unused
key.
GroupsException
public static IEntityGroup newGroup(java.lang.Class type, java.lang.String serviceName) throws GroupsException
IEntityGroup
for the given Class with an unused
key.
GroupsException
public static java.lang.String parseLocalKey(java.lang.String compositeKey) throws javax.naming.InvalidNameException, GroupsException
javax.naming.InvalidNameException
GroupsException
public static javax.naming.Name parseServiceName(java.lang.String serviceName) throws javax.naming.InvalidNameException, GroupsException
javax.naming.InvalidNameException
GroupsException
public static EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type) throws GroupsException
GroupsException
public static EntityIdentifier[] searchForEntities(java.lang.String query, int method, java.lang.Class type, IEntityGroup ancestor) throws GroupsException
GroupsException
public static EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype) throws GroupsException
GroupsException
public static EntityIdentifier[] searchForGroups(java.lang.String query, int method, java.lang.Class leaftype, IEntityGroup ancestor) throws GroupsException
GroupsException
public static void startUp() throws GroupsException
GroupsException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |