|
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.channels.groupsmanager.GroupsManagerXML
Contains a groups of static methods used to centralize the generation and retrieval of xml elements for groups and entities.
Field Summary |
Fields inherited from interface org.jasig.portal.channels.groupsmanager.GroupsManagerConstants |
ADD_REMOVE_PERMISSION, ASSIGN_PERMISSION, BASE_PACKAGE, BROWSE_MODE, COMMANDS_PACKAGE, CREATE_PERMISSION, DELETE_PERMISSION, EDIT_MODE, ENTITY_CLASSNAME, ENTITY_TAGNAME, GROUP_CLASSNAME, GROUP_TAGNAME, GROUPS_PACKAGE, MEMBERS_ONLY_MODE, OWNER, PROPERTIES_TAGNAME, ROOT_GROUP_DESCRIPTION, ROOT_GROUP_TITLE, SECURITY_PACKAGE, SELECT_MODE, SELECT_PERMISSION, UPDATE_PERMISSION, VIEW_PERMISSION, WRAPPERS_PACKAGE |
Constructor Summary | |
GroupsManagerXML()
|
Method Summary | |
static void |
clearPropertiesCache(IGroupMember gm)
Removes all EntityProperites for a GroupMember from the Entity Property cache. |
static org.w3c.dom.Element |
createElement(java.lang.String name,
org.w3c.dom.Document xmlDoc,
boolean setGrpDefault)
Creates an element for the provided Document. |
static void |
createPermissions(CGroupsManagerSessionData sessionData,
IEntityGroup childEntGrp)
Creates permissions to a group for the current user and generates permission elements |
static org.w3c.dom.Element |
createRdfElement(IEntityGroup entGrp,
org.w3c.dom.Document xmlDoc)
Returns an RDF element for the provided Document |
static void |
expandGroupElementXML(org.w3c.dom.Element expandedElem,
CGroupsManagerUnrestrictedSessionData sd)
Expands an element |
static org.w3c.dom.Element |
getAuthorizationXml(ChannelStaticData sd,
org.w3c.dom.Element apRoot,
org.w3c.dom.Document xmlDoc)
Returns an element holding the user's permissions used to determine access privileges in the Groups Manager channel. |
static org.w3c.dom.Element |
getElementById(org.w3c.dom.Document aDoc,
java.lang.String id)
Returns an element from an xml document for a unique id. |
static org.w3c.dom.Element |
getElementByTagNameAndId(org.w3c.dom.Document aDoc,
java.lang.String tagname,
java.lang.String id)
Returns an Element from a Document for a tagname and element id |
static java.lang.String |
getElementValueForTagName(org.w3c.dom.Element anElem,
java.lang.String tagname)
Returns the value of an element for a given name |
static java.lang.String |
getEntityName(java.lang.Class typClass,
java.lang.String aKey)
Returns a name from the EntityNameFinderService, for a key and class |
static java.lang.String |
getEntityName(java.lang.String className,
java.lang.String aKey)
Returns a name from the EntityNameFinderService, for a key and classname |
static java.util.HashMap |
getEntityTypes()
Returns a HashMap of entity types. |
static org.w3c.dom.Element |
getEntityTypesXml(org.w3c.dom.Document xmlDoc)
Returns an element holding the entity types used in uPortal. |
static org.w3c.dom.Element |
getExpandedElementForTagNameAndKey(org.w3c.dom.Document aDoc,
java.lang.String tagname,
java.lang.String key)
Returns an Element with the expanded attribute set to true from a Document for a tagname and IGroupMember key. |
static org.w3c.dom.Element |
getGroupMemberXml(IGroupMember gm,
boolean isContextExpanded,
org.w3c.dom.Element anElem,
CGroupsManagerUnrestrictedSessionData sd)
Returns an Element for an IGroupMember. |
static org.w3c.dom.Document |
getGroupsManagerXml(CGroupsManagerSessionData sessionData)
Returns a Document with an element for each IEntityType that has a root group. |
static org.w3c.dom.Document |
getNewDocument()
Returns a new Document |
static java.lang.String |
getNextUid()
Returns the next sequential identifier which is used to uniquely identify an element. |
static java.util.Iterator |
getNodesById(org.w3c.dom.Document aDoc,
java.lang.String id)
Even though we know we will find a single element, we sometimes want it returned in an iterator in order to streamline processing. |
static java.util.Iterator |
getNodesByTagNameAndKey(org.w3c.dom.Document aDoc,
java.lang.String tagname,
java.lang.String key)
Returns an iterator of Nodes for a Document for a tagname and IGroupMember key |
static java.util.Iterator |
getNodesByTagNameAndKey(org.w3c.dom.Element anElem,
java.lang.String tagname,
java.lang.String key)
Returns an iterator of Nodes for an Element for a tagname and IGroupMember key |
static org.w3c.dom.Element |
getPermissionXml(org.w3c.dom.Document xmlDoc,
java.lang.String prmPrincipal,
java.lang.String prmActivity,
java.lang.String prmType,
java.lang.String prmTarget)
Returns an element for a permission. |
static java.lang.String |
getTagName(IGroupMember gm)
Returns the xml tagname for a GroupMember |
static IGroupsManagerWrapper |
getWrapper(java.lang.String type)
Returns a group member wrapper. |
static boolean |
isPersistentGroup(org.w3c.dom.Element anElem)
Group elements that hold search results are non-persistent and should be treated differently. |
static void |
refreshAllNodes(CGroupsManagerUnrestrictedSessionData sd,
IEntityGroup entGrp)
Updates all nodes for the same IEntityGroup with information about the IEntityGroup. |
static void |
refreshAllNodesIfRequired(CGroupsManagerUnrestrictedSessionData sd,
org.w3c.dom.Element anElem)
Updates all nodes representing the same IEntityGroup that is represented by the anElem, if the anElem is out of date with the IEntityGroup. |
static void |
refreshAllNodesRecursivelyIfRequired(CGroupsManagerUnrestrictedSessionData sd,
org.w3c.dom.Element parentElem)
Updates all nodes representing the same IEntityGroup that is represented by the anElem, if the anElem is out of date with the IEntityGroup. |
static void |
refreshElement(org.w3c.dom.Element updElem,
IEntityGroup entGrp)
Updates an Element with information about the IEntityGroup. |
static boolean |
refreshRequired(org.w3c.dom.Element chkElem,
IEntityGroup entGrp)
Updates an Element with information about the IEntityGroup. |
static void |
removeElementsForTagName(org.w3c.dom.Element anElem,
java.lang.String tagname)
Removes all elements with the tagname from an element |
static void |
removePropertyElements(org.w3c.dom.Document model,
IGroupMember gm,
boolean clearCache)
Removes all property elements for an IGroupMember and optionally clears the Entity Property cache. |
static IEntity |
retrieveEntity(java.lang.String aKey,
java.lang.String aType)
Returns an IEntity for the key. |
static IEntityGroup |
retrieveGroup(java.lang.String aKey)
Returns an IEntityGroup for the key. |
static IGroupMember |
retrieveGroupMemberForElement(org.w3c.dom.Element gmElem)
Returns the IGroupMember represented by an Element |
static IGroupMember |
retrieveGroupMemberForElementId(org.w3c.dom.Document aDoc,
java.lang.String id)
Returns the IGroupMember represented by an Element |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public GroupsManagerXML()
Method Detail |
public static org.w3c.dom.Document getGroupsManagerXml(CGroupsManagerSessionData sessionData)
sessionData
- CGroupsManagerSessionData
public static org.w3c.dom.Element createElement(java.lang.String name, org.w3c.dom.Document xmlDoc, boolean setGrpDefault)
name
- xmlDoc
- setGrpDefault
-
public static org.w3c.dom.Element createRdfElement(IEntityGroup entGrp, org.w3c.dom.Document xmlDoc)
entGrp
- IEntityGroupxmlDoc
- Document
public static void createPermissions(CGroupsManagerSessionData sessionData, IEntityGroup childEntGrp) throws java.lang.Exception
sessionData
- CGroupsManagerSessionDatachildEntGrp
- IEntityGroup
java.lang.Exception
public static void expandGroupElementXML(org.w3c.dom.Element expandedElem, CGroupsManagerUnrestrictedSessionData sd)
expandedElem
- Elementsd
- CGroupsManagerUnrestrictedSessionDatapublic static org.w3c.dom.Element getAuthorizationXml(ChannelStaticData sd, org.w3c.dom.Element apRoot, org.w3c.dom.Document xmlDoc)
sd
- apRoot
- xmlDoc
-
public static org.w3c.dom.Element getElementById(org.w3c.dom.Document aDoc, java.lang.String id)
aDoc
- id
-
public static org.w3c.dom.Element getElementByTagNameAndId(org.w3c.dom.Document aDoc, java.lang.String tagname, java.lang.String id)
aDoc
- tagname
- id
-
public static java.lang.String getElementValueForTagName(org.w3c.dom.Element anElem, java.lang.String tagname)
anElem
- Elementtagname
- String
public static java.lang.String getEntityName(java.lang.Class typClass, java.lang.String aKey)
typClass
- aKey
-
public static java.lang.String getEntityName(java.lang.String className, java.lang.String aKey)
className
- aKey
-
public static java.util.HashMap getEntityTypes()
public static org.w3c.dom.Element getEntityTypesXml(org.w3c.dom.Document xmlDoc)
xmlDoc
-
public static org.w3c.dom.Element getExpandedElementForTagNameAndKey(org.w3c.dom.Document aDoc, java.lang.String tagname, java.lang.String key)
aDoc
- tagname
- key
-
public static org.w3c.dom.Element getGroupMemberXml(IGroupMember gm, boolean isContextExpanded, org.w3c.dom.Element anElem, CGroupsManagerUnrestrictedSessionData sd)
gm
- isContextExpanded
- anElem
- sd
- CGroupsManagerUnrestrictedSessionData
public static org.w3c.dom.Document getNewDocument()
public static java.lang.String getNextUid()
public static java.util.Iterator getNodesById(org.w3c.dom.Document aDoc, java.lang.String id)
aDoc
- id
-
public static java.util.Iterator getNodesByTagNameAndKey(org.w3c.dom.Document aDoc, java.lang.String tagname, java.lang.String key)
aDoc
- tagname
- key
-
public static java.util.Iterator getNodesByTagNameAndKey(org.w3c.dom.Element anElem, java.lang.String tagname, java.lang.String key)
anElem
- tagname
- key
-
public static org.w3c.dom.Element getPermissionXml(org.w3c.dom.Document xmlDoc, java.lang.String prmPrincipal, java.lang.String prmActivity, java.lang.String prmType, java.lang.String prmTarget)
xmlDoc
- prmPrincipal
- prmActivity
- prmType
- prmTarget
-
public static IGroupsManagerWrapper getWrapper(java.lang.String type)
type
-
public static boolean isPersistentGroup(org.w3c.dom.Element anElem)
anElem
- Element
public static void refreshAllNodes(CGroupsManagerUnrestrictedSessionData sd, IEntityGroup entGrp)
sd
- CGroupsManagerUnrestrictedSessionDataentGrp
- IEntityGrouppublic static void refreshAllNodesIfRequired(CGroupsManagerUnrestrictedSessionData sd, org.w3c.dom.Element anElem)
sd
- CGroupsManagerUnrestrictedSessionDataanElem
- Elementpublic static void refreshAllNodesRecursivelyIfRequired(CGroupsManagerUnrestrictedSessionData sd, org.w3c.dom.Element parentElem)
sd
- CGroupsManagerUnrestrictedSessionDataparentElem
- Elementpublic static void refreshElement(org.w3c.dom.Element updElem, IEntityGroup entGrp)
updElem
- ElemententGrp
- IEntityGrouppublic static boolean refreshRequired(org.w3c.dom.Element chkElem, IEntityGroup entGrp)
chkElem
- ElemententGrp
- IEntityGroup
public static IEntity retrieveEntity(java.lang.String aKey, java.lang.String aType)
aKey
- aType
-
public static IEntityGroup retrieveGroup(java.lang.String aKey)
aKey
-
public static IGroupMember retrieveGroupMemberForElementId(org.w3c.dom.Document aDoc, java.lang.String id)
aDoc
- id
-
public static IGroupMember retrieveGroupMemberForElement(org.w3c.dom.Element gmElem)
gmElem
-
public static java.lang.String getTagName(IGroupMember gm)
gm
- IGroupMember
public static void removeElementsForTagName(org.w3c.dom.Element anElem, java.lang.String tagname)
anElem
- Elementtagname
- Stringpublic static void removePropertyElements(org.w3c.dom.Document model, IGroupMember gm, boolean clearCache)
model
- Elementgm
- IGroupMemberclearCache
- booleanpublic static void clearPropertiesCache(IGroupMember gm)
gm
- IGroupMember
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |