|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.GrouperHelper
public class GrouperHelper
High level wrapper methods for the Grouper API, including workarounds. Primarily developed for the UI.
Occasionally takes advantage of protected access to the Grouper API, however, this access should not be required once the API is fully implemented.
Field Summary | |
---|---|
static String |
HIER_DELIM
|
static HashMap |
list2privMap
|
static String |
NS_ROOT
|
Constructor Summary | |
---|---|
GrouperHelper()
|
Method Summary | |
---|---|
static void |
assignPrivileges(GrouperSession s,
String stemOrGroupId,
Subject[] members,
String[] privileges,
boolean forStems)
Given a GroupeGroup or GrouperStem id, an array of subjects and an array of privileges, grant the privileges to each subject for the GrouperStem or GrouperGroup |
static void |
assignPrivileges(GrouperSession s,
String stemOrGroupId,
Subject[] members,
String[] privileges,
boolean forStems,
Field field)
Given a GroupeGroup or GrouperStem id, an array of subjects and an array of privileges, grant the privileges to each subject for the GrouperStem or GrouperGroup |
static boolean |
canCopyGroupToStem(Stem stem,
Set<Privilege> privs)
Returns true if the following parameters would allow a subject to copy a group to the specified stem. |
static boolean |
canCopyOtherStemToStem(Stem stem,
boolean canCopy,
Set<Privilege> privs)
Returns true if the following parameter values would allow a subject to copy a stem to the specified stem. |
static boolean |
canCopyStem(Stem stem,
boolean canCopy)
Return true if the following parameter values would allow a subject to copy the specified stem to another location. |
static boolean |
canMoveGroupToStem(Stem stem,
Set<Privilege> privs)
Returns true if the following parameters would allow a subject to move a group to the specified stem. |
static boolean |
canMoveOtherStemToStem(Stem stem,
boolean canMove,
Set<Privilege> privs)
Returns true if the following parameters would allow a subject to move a stem to the specified stem. |
static boolean |
canMoveStem(Stem stem,
boolean canMove,
Set<Privilege> privs)
Returns true if the following parameter values would allow a subject to move the specified stem to another location. |
static boolean |
canRead(GrouperSession s,
Field field,
Group g)
Can the current user read this field? Should probably remove, API support is there now |
static boolean |
canUserEditAnyCustomAttribute(Group group)
Returns whether the user associated with the active GrouperSession can edit any cuustom attribute associate with the supplied group |
static boolean |
canWrite(GrouperSession s,
Field field,
Group g)
Can the current write read this field? Should probably remove, API support is there now |
static Group |
copyGroup(Group group,
Stem destinationStem,
String[] selections)
Copy a group |
static Stem |
copyStem(Stem stemToCopy,
Stem destinationStem,
String[] selections)
Copy a stem |
static Stem |
createIfAbsentPersonalStem(GrouperSession s,
PersonalStem ps)
Given a PersonalStem create stem in correct location - depends on configuration. |
static List |
embellishGroupMapsWithSubjectPrivs(GrouperSession s,
List groups,
Subject subject)
Supplement group maps with privilege info for provided subject assuming subject has any privileges for this group |
static List |
filterGroupsForSubject(GrouperSession s,
List groups,
Subject subject)
Filter groups according to privileges of session subject and whether provided subject has any privileges for this group |
static void |
fixSessionFields(Map fieldList)
When we query fields we 'accumulate' them so we can check if tere are any new ones. |
static Map |
getAllHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member)
Returns all privileges, direct and indirect, that member has for group or stem |
static Map |
getAllHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member,
Field field)
Returns all privileges, direct and indirect, that member has for group or stem |
static List |
getAllWaysInWhichSubjectIsMemberOFGroup(GrouperSession s,
Subject subject,
Group group,
Field field)
API lets you get all memberships - this filters them for a specific group |
static List |
getChain(GrouperSession s,
Membership m)
Return the path by which this Membership is derived |
static String[] |
getChainGroupIds(GrouperSession s,
Membership list)
|
static List |
getChildren(GrouperSession s,
String stemId)
Given a GrouperStem id return a list of stems and groups for which the GrouperStem is an immediate parent |
static Map |
getCompositeMap(GrouperSession grouperSession,
Composite comp)
Given a composite return a Map for use in Tiles |
static Map |
getCompositeMap(GrouperSession grouperSession,
Composite comp,
Subject subj)
Given a composite return a Map for use in Tiles. |
static Map |
getDefaultAccessPrivsForGrouperAPI()
Queries GrouperConfig - grouper.properties - to determine which Access privs are granted to GrouperAll on group creation |
static Map |
getDefaultAccessPrivsForUI(ResourceBundle mediaBundle)
Checks key groups.create.grant.all to determine pre-selected privs to be checked in the UI. |
static Map |
getEffectiveHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member,
Field field)
Returns indirect privileges for member on the group or stem - but not how derived |
static Map |
getEffectiveMembershipsForGroupAndSubject(GrouperSession s,
Group group,
Subject subject,
Field field)
Given a Group and Subject return the effective memberships keyed on the via group |
static Map |
getExtendedHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member)
Returns indirect privileges for member on the group or stem |
static Map |
getExtendedHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member,
Field field)
Returns indirect privileges for member on the group or stem |
static Map |
getFieldsAsMap()
Retrieve Map of attributes which can be searched |
static Map |
getFieldsForGroup(GrouperSession s,
Group g,
String priv)
For a group, for all its types, return fields user can read / write |
static String[] |
getGroupPrivs(GrouperSession s)
Return an array of all access privileges |
static String[] |
getGroupPrivsWithMember(GrouperSession s)
Return an array of all access privileges + member |
static Set |
getGroupsForPrivileges(GrouperSession s,
String[] privs)
Given a GrouperSession s, and an array of privileges, get all groups where s.subject() has atleast one of the privileges |
static Set |
getGroupsForPrivileges(GrouperSession s,
String[] privs,
int start,
int pageSize,
StringBuffer resultCount)
Given a GrouperSession s, and an array of privileges, get subset of groups where s.subject() has atleast one of the privileges, determined by start and pageSize resultCount is a dubious means to return a second value to allow the UI to page results |
static Set |
getGroupsOrStemsWhereMemberHasPriv(Member member,
String privilege)
Given a privilege return all the groups or stems where member has that privilege |
static Set |
getGroupsWhereMemberHasPriv(Member member,
String privilege)
Given a privilege return all the groups where member has that privilege |
static Map |
getImmediateHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member)
Returns direct privileges for member on group or stem |
static Map |
getImmediateHas(GrouperSession s,
GroupOrStem groupOrStem,
Member member,
Field field)
Returns direct privileges for member on group or stem |
static List |
getListFieldsForGroup(GrouperSession s,
Group g)
For a group, for all its types, return fields of type LIST |
static List |
getListFieldsForGroup(GrouperSession s,
String groupId)
For a group id, for all its types, return fields of type LIST |
static List |
getListFieldsForSubject(GrouperSession s,
Subject subject)
For a given subject determine all the custom list fields they appear in |
static String |
getMemberDisplayValue(Member member,
ResourceBundle bundle)
|
static Map |
getMemberships(GrouperSession s)
Given a GrouperSession s, determine all the GrouperGroups s.subject() is a member of and return a Map where the keys are GrouperGroup keys |
static Set |
getMembershipsSet(GrouperSession s)
Given a GrouperSession s, determine all the GrouperGroups s.subject() is a member of and return a Set of GrouperGroups |
static Set |
getMembershipsSet(GrouperSession s,
int start,
int pageSize,
StringBuffer totalCount)
Given a GrouperSession s, return a subset of Groups where s.subject is a member, determined by start and pageSize. totalCount is a dubious means to return a second value to allow the UI to page results |
static String |
getMemberUuid(Membership m)
Rather than force a client to call getMember which involves a SQL query expose the memberUuid where that is sufficient |
static List<Membership> |
getOneMembershipPerSubjectOrGroup(Set memberships,
String type,
Map count,
Map sources,
int membersFilterLimit)
Trims down input so that the 'same' membership does not occur twice |
static List |
getPersonSources()
Query Subject API for sources and determine which ones return 'people' |
static List |
getReadableListFieldsForGroup(GrouperSession s,
Group g)
For a group id, for all its types, return fields of type LIST which the session user can read or write |
static List |
getReadableListFieldsForGroup(GrouperSession s,
String groupId)
For a group id, for all its types, return fields of type LIST which the session user can read or write |
static GrouperSession |
getRootGrouperSession(GrouperSession s)
|
static List |
getSearchableFields(ResourceBundle bundle)
Retrieve list of attributes which can be searched |
static List |
getSearchableStemFields(ResourceBundle bundle)
Returns a list of Maps representing name / displayNames for stem fields Stems don't have fields in the way Groups do. |
static String[] |
getStemPrivs(GrouperSession s)
Return an array of all naming privileges |
static Collection |
getStemPrivsWithLabels(ResourceBundle bundle)
Return a Collection of all naming privileges |
static Set |
getStemsForPrivileges(GrouperSession s,
String[] privs)
Given a GrouperSession s, and an array of privileges, get all stems where s.subject() has atleast one of the privileges |
static Set |
getStemsForPrivileges(GrouperSession s,
String[] privs,
int start,
int pageSize,
StringBuffer resultCount)
Given a GrouperSession s, and an array of privileges, get subset of stems where s.subject() has atleast one of the privileges, determined by start and pageSize resultCount is a dubious means to return a second value to allow the UI to page results |
static Set |
getStemsWhereMemberHasPriv(Member member,
String privilege)
Given a privilege return all the stems where member has that privilege |
static Subject |
getSubjectFromIdAndType(String subjectId,
String subjectType)
Given a Subject id and SubjectType return a Subject - or null if one not found |
static Set |
getSubjectsWithPriv(Group group,
String privilege)
Given priv name return subjects with that privilege for group |
static Set |
getSubjectsWithPriv(Stem stem,
String privilege)
Given priv name return subjects with that privilege for stem |
static List |
getWritableListFieldsForGroup(GrouperSession s,
Group g)
For a group id, for all its types, return fields of type LIST which the session user can write |
static List |
getWritableListFieldsForGroup(GrouperSession s,
String groupId)
For a group id, for all its types, return fields of type LIST which the session user can write |
static Map |
group2Map(GrouperSession s,
Group group)
Given a Group return a Map representation of it |
static Map |
group2Map(GrouperSession s,
GroupOrStem groupOrStem)
Given a GroupOrStem return a Map representing it |
static Map |
group2Map(GrouperSession s,
Stem stem)
Given a Stem return a Map representing it |
static boolean |
groupDelete(GrouperSession s,
GroupOrStem groupOrStem)
Given a GrouperGroup or GroupeStem delete it. |
static List |
groupList2SubjectsMaps(GrouperSession s,
List members)
Given a list of GrouperMembers return a list of Map representations of them |
static List |
groupList2SubjectsMaps(GrouperSession s,
List members,
int start,
int pageSize)
Given a list of GrouperList objects return a sublist from start to start + pageSize of each GrouperList.member() as a Map |
static List |
groupList2SubjectsMaps(GrouperSession s,
List members,
String asMemberOf)
Given a list of GrouperMembers return a list of Map representations of them where the key asMemberOf is set to the value of the parameter asMemberOf |
static List |
groupList2SubjectsMaps(GrouperSession s,
List members,
String asMemberOf,
int start,
int pageSize)
Given a list of GrouperMembers return a list of Map representations of a sublist of them (from start to start + pageSize) where the key asMemberOf is set to the value of the parameter asMemberOf |
static Group |
groupLoadById(GrouperSession s,
String id)
Given a GrouperGroup id return the GrouperGroup |
static List |
groups2Maps(GrouperSession s,
List groups)
Given a list of GrouperAttributes, return a list of GrouperGroups which the attributes belong to, and load all atributes for these groups |
static Map |
hasAsMap(GrouperSession s,
GroupOrStem groupOrStem)
Given a GrouperGroup or GrouperStem return a Map where the keys are access or naming privileges that s.subject() has. |
static Map |
hasAsMap(GrouperSession s,
GroupOrStem groupOrStem,
boolean isMortal)
Given a GrouperGroup or GrouperStem return a Map where the keys are access or naming privileges that s.subject() has. |
static Map |
hasAsMap(GrouperSession s,
GroupOrStem groupOrStem,
Member member,
Field field)
Given a GrouperGroup or GrouperStem return a Map where the keys are access or naming privileges that member.subject() has. |
static boolean |
hasOtherReadableFields(Group g,
String fieldName)
|
static boolean |
hasSubjectImmPrivForGroup(GrouperSession s,
Subject subject,
Group group,
String privilege)
Determine if a given subject has been granted an Access privilege through direct assignment |
static boolean |
hasSubjectImmPrivForStem(GrouperSession s,
Subject subject,
Stem stem,
String privilege)
Determine if a given subject has been granted a Naming privilege through direct assignment |
static boolean |
isDirect(LazySubject ls)
|
static boolean |
isRoot(GrouperSession s)
|
static boolean |
isSuperUser(GrouperSession s)
Is s.subject() the system user? |
static Map |
listOfFieldsToMap(List fields)
|
static void |
main(String[] args)
|
static List |
memberships2Maps(GrouperSession s,
Collection memberships)
Use to get MembershipMaps rather than SubjectMaps. |
static List |
memberships2Maps(GrouperSession s,
Collection memberships,
boolean withParents)
Use to get MembershipMaps rather than SubjectMaps. |
static void |
moveGroup(Group group,
Stem destinationStem,
String[] selections)
Move a group |
static void |
moveStem(Stem stemToMove,
Stem destinationStem,
String[] selections)
Move a stem |
static List |
parentStemsAsMaps(GrouperSession s,
GroupOrStem groupOrStem)
Given a GrouperGroup or GrouperStem return a list of ancestor GrouperStems as Maps |
static List |
searchGroups(GrouperSession s,
String query,
String from,
String searchInDisplayNameOrExtension,
String searchInNameOrExtension)
Given a simple query and scoping stem search for matching groups and return as List |
static List |
searchGroups(GrouperSession s,
String query,
String from,
String searchInDisplayNameOrExtension,
String searchInNameOrExtension,
String browseMode)
Given simple query, scoping stem and ui browseMode return list of matching groups, pruned to give results relevant to browseMode. The browseMode filtering needs to be factored into a new Class with interface so that new browse modes can be added easily |
static List |
searchGroupsByAttribute(GrouperSession s,
String query,
String from,
String attr)
Given a simple query and scoping stem search for matching groups and return as List |
static List |
searchStems(GrouperSession s,
String query,
String from,
String searchInDisplayNameOrExtension,
String searchInNameOrExtension)
Given a simple query and scoping stem search for matching stems and return as List |
static List |
searchStemsByAttribute(GrouperSession s,
String query,
String from,
String attr)
Given a simple query and scoping stem and attribute, search for matching stems and return as List |
static void |
setMembershipCountPerSubjectOrGroup(List membershipMaps,
String type,
Map count)
Given a trimmed list of memberships which are now Maps, add noWays -> number of direct and indirect memberships |
static Map |
stem2Map(GrouperSession s,
Stem stem)
Given a GrouperStem return a Map representing it |
static List |
stems2Maps(GrouperSession s,
List stems)
Given a ist of GrouperList objects return a list of instantiated GrouperStems as Maps |
static Map |
subject2Map(GrouperSession s,
String subjectId,
String subjectType,
String sourceId)
Given a subject id and subject type return a Map representation of it. |
static Map |
subject2Map(GrouperSession s,
String subjectId,
String subjectType,
String sourceId,
Map addAttr)
Given a subject id and subject type and a Map, return a Map representation of the subject and add the key/value pairs from the input Map. |
static Map |
subject2Map(Subject subject)
Given a Subject return a Map representation of it |
static Map<Object,Object> |
subject2Map(Subject subject,
Map addAttr)
Given a Subject return a Map representation of it |
static List |
subjects2Maps(Object[] objects)
Given an array of Subjects return a List of Maps representing those subjects |
static List |
subjects2Maps(Object[] objects,
Map addAttr)
Given an array of Subjects return a List of Maps representing those subjects |
static List |
subjects2Maps(Subject[] subjects)
Given an array of Subjects return a List of Maps representing those subjects |
static List<Map<Object,Object>> |
subjects2Maps(Subject[] subjects,
Map addAttr)
Given an array of Subjects return a List of Maps representing those subjects |
static List |
subjects2SubjectPrivilegeMaps(GrouperSession s,
Collection subjects,
GroupOrStem groupOrStem,
String privilege)
Use to get SubjectPrivilegeMaps rather than SubjectMaps. |
static List |
subjects2SubjectPrivilegeMaps(GrouperSession s,
Collection subjects,
Group group,
String privilege)
Use to get SubjectPrivilegeMaps rather than SubjectMaps. |
static List |
subjects2SubjectPrivilegeMaps(GrouperSession s,
Collection subjects,
Stem stem,
String privilege)
Use to get SubjectPrivilegeMaps rather than SubjectMaps. |
static List |
subjects2SubjectPrivilegeMaps(GrouperSession s,
Collection groupsOrStems,
Subject subject,
String privilege)
Use to get SubjectPrivilegeMaps rather than SubjectMaps. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static HashMap list2privMap
public static final String HIER_DELIM
public static final String NS_ROOT
Constructor Detail |
---|
public GrouperHelper()
Method Detail |
---|
public static void main(String[] args) throws Exception
Exception
public static List getChildren(GrouperSession s, String stemId) throws StemNotFoundException
s
- GrouperSession for authenticated userstemId
- GrouperStem id
StemNotFoundException
public static List groups2Maps(GrouperSession s, List groups) throws GroupNotFoundException
s
- GrouperSession for authenticated userlist
- of GrouperAtributes
GroupNotFoundException
public static List stems2Maps(GrouperSession s, List stems) throws GroupNotFoundException
s
- GrouperSession for authenticated userstems
- List of GrouperLists
GroupNotFoundException
public static Map stem2Map(GrouperSession s, Stem stem)
s
- GrouperSession for authenticated userstem
- GrouperStem to wrap
public static Map group2Map(GrouperSession s, Stem stem)
s
- GrouperSession for authenticated userstem
- GrouperStem to wrap
public static Map group2Map(GrouperSession s, GroupOrStem groupOrStem)
s
- GrouperSession for authenticated usergroupOrStem
- GroupOrStem to wrap
public static Map group2Map(GrouperSession s, Group group)
s
- GrouperSession for authenticated usergroup
- Group to wrap
public static List parentStemsAsMaps(GrouperSession s, GroupOrStem groupOrStem) throws StemNotFoundException
s
- GrouperSession for authenticated usergroupOrStem
- GrouperGroup or GrouperStem
StemNotFoundException
public static Map hasAsMap(GrouperSession s, GroupOrStem groupOrStem) throws MemberNotFoundException
s
- GrouperSession for authenticated usergroupOrStem
- GrouperGroup or GroupeStem for which privileges are being requested
MemberNotFoundException
public static Map hasAsMap(GrouperSession s, GroupOrStem groupOrStem, boolean isMortal) throws MemberNotFoundException
s
- GrouperSession for authenticated usergroupOrStem
- GrouperGroup or GroupeStem for which privileges are being requestedisMortal
- if system user should they be teated as such
MemberNotFoundException
public static Map hasAsMap(GrouperSession s, GroupOrStem groupOrStem, Member member, Field field) throws SubjectNotFoundException, SchemaException
s
- GrouperSession for authenticated usergroupOrStem
- GrouperGroup or GroupeStem for which privileges are being requestedmember
- Subject who privileges were granted to
SubjectNotFoundException
SchemaException
public static Map subject2Map(Subject subject)
subject
- to be wrapped
public static Map<Object,Object> subject2Map(Subject subject, Map addAttr)
subject
- to be wrappedaddAttr
- Map of additional attributes
public static Map subject2Map(GrouperSession s, String subjectId, String subjectType, String sourceId, Map addAttr) throws SubjectNotFoundException
s
- GrouperSession for authenticated usersubjectId
- Subject idsubjectType
- Subject type e.g. person, groupaddAttr
- Map of aditional attributes
SubjectNotFoundException
public static Map subject2Map(GrouperSession s, String subjectId, String subjectType, String sourceId) throws SubjectNotFoundException
s
- GrouperSession for authenticated usersubjectId
- Subject idsubjectType
- Subject type e.g. person, group
SubjectNotFoundException
public static List subjects2Maps(Object[] objects, Map addAttr)
objects
- array of SubjectsaddAttr
- Map of additional attributes
public static List subjects2Maps(Object[] objects)
objects
- array of Subjects
public static List<Map<Object,Object>> subjects2Maps(Subject[] subjects, Map addAttr)
subjects
- array of SubjectsaddAttr
- Map of aditional attributes
public static List subjects2Maps(Subject[] subjects)
subjects
- array of Subjects
public static List groupList2SubjectsMaps(GrouperSession s, List members, int start, int pageSize) throws GroupNotFoundException, SubjectNotFoundException, MemberNotFoundException, SubjectNotUniqueException
s
- GrouperSession for authenticated usermembers
- List of GrouperLists or GrouperMembersstart
- 0 based start indexpageSize
- number of results to return
GroupNotFoundException
SubjectNotFoundException
MemberNotFoundException
SubjectNotUniqueException
public static List groupList2SubjectsMaps(GrouperSession s, List members) throws GroupNotFoundException, SubjectNotFoundException, MemberNotFoundException, SubjectNotUniqueException
s
- GrouperSession for authenticated usermembers
- List of GrouperLists or GrouperMembers
GroupNotFoundException
SubjectNotFoundException
MemberNotFoundException
SubjectNotUniqueException
public static List groupList2SubjectsMaps(GrouperSession s, List members, String asMemberOf) throws GroupNotFoundException, SubjectNotFoundException, MemberNotFoundException, SubjectNotUniqueException
s
- GrouperSession for authenticated usermembers
- List of GrouperLists or GrouperMembersasMemberOf
- GrouperGroup id identifying context
GroupNotFoundException
SubjectNotFoundException
MemberNotFoundException
SubjectNotUniqueException
public static List groupList2SubjectsMaps(GrouperSession s, List members, String asMemberOf, int start, int pageSize) throws GroupNotFoundException, SubjectNotFoundException, MemberNotFoundException, SubjectNotUniqueException
s
- GrouperSession for authenticated usermembers
- List of GrouperLists or GrouperMembersasMemberOf
- GrouperGroup id identifying contextstart
- of sublistpageSize
- number of results to return
GroupNotFoundException
SubjectNotFoundException
MemberNotFoundException
SubjectNotUniqueException
public static String[] getChainGroupIds(GrouperSession s, Membership list) throws MemberNotFoundException, GroupNotFoundException
MemberNotFoundException
GroupNotFoundException
public static void assignPrivileges(GrouperSession s, String stemOrGroupId, Subject[] members, String[] privileges, boolean forStems) throws SchemaException, MemberAddException, InsufficientPrivilegeException, MemberNotFoundException, GrantPrivilegeException
s
- GrouperSession for authenticated userstemOrGroupId
- GrouperGroup or GrouperStem idmembers
- array of Subjectsprivileges
- array of privilegesforStems
- indicates GrouperStem
SchemaException
MemberAddException
InsufficientPrivilegeException
MemberNotFoundException
GrantPrivilegeException
public static void assignPrivileges(GrouperSession s, String stemOrGroupId, Subject[] members, String[] privileges, boolean forStems, Field field) throws SchemaException, MemberAddException, InsufficientPrivilegeException, MemberNotFoundException, GrantPrivilegeException
s
- GrouperSession for authenticated userstemOrGroupId
- GrouperGroup or GrouperStem idmembers
- array of Subjectsprivileges
- array of privilegesforStems
- indicates GrouperStem
SchemaException
MemberAddException
InsufficientPrivilegeException
MemberNotFoundException
GrantPrivilegeException
public static boolean isSuperUser(GrouperSession s)
s
- GrouperSession for authenticated user
public static Subject getSubjectFromIdAndType(String subjectId, String subjectType)
subjectId
- Subject idsubjectType
- Subject type
public static Group groupLoadById(GrouperSession s, String id) throws GroupNotFoundException
s
- GrouperSession for authenticated userid
- GrouperGroup id
GroupNotFoundException
public static String[] getGroupPrivsWithMember(GrouperSession s)
s
- GrouperSession for authenticated user
public static String[] getGroupPrivs(GrouperSession s)
s
- GrouperSession for authenticated user
public static String[] getStemPrivs(GrouperSession s)
s
- GrouperSession for authenticated user
public static Collection getStemPrivsWithLabels(ResourceBundle bundle)
bundle
- ResourceBundle to lookup display name
public static List searchGroupsByAttribute(GrouperSession s, String query, String from, String attr) throws QueryException, StemNotFoundException
s
- GrouperSession for authenticated userquery
- to search forfrom
- stem which scopes searchattr
- name of attribute to search
QueryException
StemNotFoundException
public static List searchGroups(GrouperSession s, String query, String from, String searchInDisplayNameOrExtension, String searchInNameOrExtension) throws StemNotFoundException, QueryException
s
- GrouperSession for authenticated userquery
- to search forfrom
- stem which scopes searchsearchInDisplayNameOrExtension
- name=displayName / extemsion=displayExtensionsearchInNameOrExtension
- name=name / extemsion=extension
StemNotFoundException
QueryException
public static List searchGroups(GrouperSession s, String query, String from, String searchInDisplayNameOrExtension, String searchInNameOrExtension, String browseMode) throws Exception
s
- GrouperSession for authenticated userquery
- to search forfrom
- Stem which scopes searchsearchInDisplayNameOrExtension
- name=displayName / extension=displayExtensionsearchInNameOrExtension
- name=name / extension=extensionbrowseMode
- UI browse mode to filter results by
Exception
public static List searchStemsByAttribute(GrouperSession s, String query, String from, String attr)
s
- GrouperSession for authenticated userquery
- to search forfrom
- stem which scopes searchattr
- name of attribute to search
public static List searchStems(GrouperSession s, String query, String from, String searchInDisplayNameOrExtension, String searchInNameOrExtension) throws StemNotFoundException, QueryException
s
- GrouperSession for authenticated userquery
- to search forfrom
- stem which scopes searchsearchInDisplayNameOrExtension
- name=displayName / extemsion=displayExtensionsearchInNameOrExtension
- name=name / extemsion=extension
StemNotFoundException
QueryException
public static Set getMembershipsSet(GrouperSession s)
s
- GrouperSession for authenticated user
public static Map getMemberships(GrouperSession s)
s
- GrouperSession for authenticated user
public static Set getMembershipsSet(GrouperSession s, int start, int pageSize, StringBuffer totalCount)
s
- GrouperSession for authenticated userstart
- where subset beginspageSize
- no of groups to returntotalCount
- number of overall results
public static Set getGroupsForPrivileges(GrouperSession s, String[] privs) throws MemberNotFoundException
s
- GrouperSession for authenticated userprivs
- privileges to test
MemberNotFoundException
public static Set getGroupsForPrivileges(GrouperSession s, String[] privs, int start, int pageSize, StringBuffer resultCount) throws MemberNotFoundException
s
- GrouperSession for authenticated userprivs
- privileges to teststart
- of subsetpageSize
- number of GrouperGroups to returnresultCount
- overall number of GrouperGroups
MemberNotFoundException
public static Set getStemsForPrivileges(GrouperSession s, String[] privs) throws MemberNotFoundException
s
- GrouperSession for authenticated userprivs
- privileges to test
MemberNotFoundException
public static Set getStemsForPrivileges(GrouperSession s, String[] privs, int start, int pageSize, StringBuffer resultCount) throws MemberNotFoundException
s
- GrouperSession for authenticated userprivs
- privileges to teststart
- where subset beginspageSize
- number of GrouperStems to returnresultCount
- overall number of GrouperStems
MemberNotFoundException
public static boolean groupDelete(GrouperSession s, GroupOrStem groupOrStem) throws InsufficientPrivilegeException, MemberNotFoundException, SubjectNotFoundException, MemberDeleteException, SessionException
s
- GrouperSession for authenticated usergroupOrStem
- GrouperGroup or GrouperStem to delete
InsufficientPrivilegeException
MemberNotFoundException
SubjectNotFoundException
MemberDeleteException
SessionException
public static Stem createIfAbsentPersonalStem(GrouperSession s, PersonalStem ps) throws Exception
s
- GrouperSession for authenticated userps
- PersonalStem
Exception
public static List getPersonSources() throws Exception
Exception
public static List getAllWaysInWhichSubjectIsMemberOFGroup(GrouperSession s, Subject subject, Group group, Field field) throws MemberNotFoundException, GroupNotFoundException, SchemaException, CompositeNotFoundException
s
- subject
- group
-
MemberNotFoundException
GroupNotFoundException
SchemaException
CompositeNotFoundException
public static Map getExtendedHas(GrouperSession s, GroupOrStem groupOrStem, Member member) throws SchemaException
s
- groupOrStem
- member
-
SchemaException
public static Map getExtendedHas(GrouperSession s, GroupOrStem groupOrStem, Member member, Field field) throws SchemaException
s
- groupOrStem
- member
-
SchemaException
public static Map getEffectiveHas(GrouperSession s, GroupOrStem groupOrStem, Member member, Field field) throws SchemaException
s
- groupOrStem
- member
-
SchemaException
public static Map getImmediateHas(GrouperSession s, GroupOrStem groupOrStem, Member member) throws SchemaException
s
- groupOrStem
- member
-
SchemaException
public static Map getImmediateHas(GrouperSession s, GroupOrStem groupOrStem, Member member, Field field) throws SchemaException
s
- groupOrStem
- member
- field
-
SchemaException
public static Map getAllHas(GrouperSession s, GroupOrStem groupOrStem, Member member) throws SchemaException
s
- groupOrStem
- member
-
SchemaException
public static Map getAllHas(GrouperSession s, GroupOrStem groupOrStem, Member member, Field field) throws SchemaException
s
- groupOrStem
- member
-
SchemaException
public static Map getEffectiveMembershipsForGroupAndSubject(GrouperSession s, Group group, Subject subject, Field field) throws Exception
s
- group
- subject
- field
-
Exception
public static Set getSubjectsWithPriv(Group group, String privilege)
group
- privilege
-
public static Set getGroupsOrStemsWhereMemberHasPriv(Member member, String privilege)
member
- privilege
-
public static Set getGroupsWhereMemberHasPriv(Member member, String privilege)
member
- privilege
-
public static Set getStemsWhereMemberHasPriv(Member member, String privilege)
member
- privilege
-
public static Set getSubjectsWithPriv(Stem stem, String privilege)
stem
- privilege
-
public static boolean hasSubjectImmPrivForGroup(GrouperSession s, Subject subject, Group group, String privilege) throws MemberNotFoundException, SchemaException
s
- subject
- group
- privilege
-
MemberNotFoundException
SchemaException
public static boolean hasSubjectImmPrivForStem(GrouperSession s, Subject subject, Stem stem, String privilege) throws MemberNotFoundException, SchemaException
s
- subject
- stem
- privilege
-
MemberNotFoundException
SchemaException
public static List getChain(GrouperSession s, Membership m) throws GroupNotFoundException, MembershipNotFoundException, MemberNotFoundException, SchemaException, SubjectNotFoundException
s
- m
-
GroupNotFoundException
MembershipNotFoundException
MemberNotFoundException
SchemaException
SubjectNotFoundException
public static Map getCompositeMap(GrouperSession grouperSession, Composite comp) throws GroupNotFoundException, MemberNotFoundException, SchemaException, SubjectNotFoundException
grouperSession
- comp
-
GroupNotFoundException
MemberNotFoundException
SchemaException
SubjectNotFoundException
public static Map getCompositeMap(GrouperSession grouperSession, Composite comp, Subject subj) throws GroupNotFoundException, MemberNotFoundException, SchemaException, SubjectNotFoundException
grouperSession
- comp
- subj
-
GroupNotFoundException
MemberNotFoundException
SchemaException
SubjectNotFoundException
public static List<Membership> getOneMembershipPerSubjectOrGroup(Set memberships, String type, Map count, Map sources, int membersFilterLimit) throws MemberNotFoundException, GroupNotFoundException
memberships
- type
- count
- - keeps track of the number of times a membership occurredsources
- - keeps track of different sources providing subjects
MemberNotFoundException
GroupNotFoundException
public static void setMembershipCountPerSubjectOrGroup(List membershipMaps, String type, Map count) throws GroupNotFoundException, MemberNotFoundException
membershipMaps
- type
- count
-
GroupNotFoundException
MemberNotFoundException
public static Map getDefaultAccessPrivsForUI(ResourceBundle mediaBundle)
mediaBundle
-
public static Map getDefaultAccessPrivsForGrouperAPI()
public static List subjects2SubjectPrivilegeMaps(GrouperSession s, Collection subjects, Group group, String privilege)
s
- subjects
- group
- privilege
-
public static List subjects2SubjectPrivilegeMaps(GrouperSession s, Collection subjects, Stem stem, String privilege)
s
- subjects
- stem
- privilege
-
public static List subjects2SubjectPrivilegeMaps(GrouperSession s, Collection subjects, GroupOrStem groupOrStem, String privilege)
s
- subjects
- groupOrStem
- privilege
-
public static List subjects2SubjectPrivilegeMaps(GrouperSession s, Collection groupsOrStems, Subject subject, String privilege)
s
- groupsOrStems
- subject
- privilege
-
public static List memberships2Maps(GrouperSession s, Collection memberships)
s
- memberships
-
public static List memberships2Maps(GrouperSession s, Collection memberships, boolean withParents)
s
- memberships
- withParents
-
public static List getListFieldsForSubject(GrouperSession s, Subject subject) throws Exception
s
- subject
-
Exception
public static Map listOfFieldsToMap(List fields)
public static List getWritableListFieldsForGroup(GrouperSession s, String groupId) throws Exception
s
- groupId
-
Exception
public static List getWritableListFieldsForGroup(GrouperSession s, Group g) throws Exception
s
- g
-
Exception
public static List getReadableListFieldsForGroup(GrouperSession s, String groupId) throws Exception
s
- groupId
-
Exception
public static List getReadableListFieldsForGroup(GrouperSession s, Group g) throws Exception
s
- g
-
Exception
public static List getListFieldsForGroup(GrouperSession s, String groupId) throws Exception
s
- groupId
-
Exception
public static List getListFieldsForGroup(GrouperSession s, Group g) throws SchemaException
s
- g
-
SchemaException
public static Map getFieldsForGroup(GrouperSession s, Group g, String priv) throws SchemaException
s
- g
- priv
- read / write
SchemaException
public static boolean canRead(GrouperSession s, Field field, Group g) throws SchemaException
s
- field
- g
-
SchemaException
public static boolean canWrite(GrouperSession s, Field field, Group g) throws SchemaException
s
- field
- g
-
SchemaException
public static List getSearchableFields(ResourceBundle bundle) throws SchemaException
SchemaException
public static void fixSessionFields(Map fieldList) throws SchemaException
fieldList
- Map of FieldAsMaps from the HttpSession
SchemaException
public static Map getFieldsAsMap() throws SchemaException
SchemaException
public static boolean canUserEditAnyCustomAttribute(Group group) throws SchemaException
group
-
SchemaException
public static List getSearchableStemFields(ResourceBundle bundle)
bundle
-
public static List filterGroupsForSubject(GrouperSession s, List groups, Subject subject)
s
- groups
- subject
-
public static List embellishGroupMapsWithSubjectPrivs(GrouperSession s, List groups, Subject subject) throws Exception
s
- groups
- subject
-
Exception
public static String getMemberUuid(Membership m)
m
-
public static boolean isRoot(GrouperSession s)
public static GrouperSession getRootGrouperSession(GrouperSession s)
public static boolean isDirect(LazySubject ls)
public static boolean hasOtherReadableFields(Group g, String fieldName)
public static boolean canCopyStem(Stem stem, boolean canCopy)
stem
- canCopy
- This is false if there's a security group limiting the subjects
that can copy stems and this subject is not in the group.
public static boolean canMoveStem(Stem stem, boolean canMove, Set<Privilege> privs)
stem
- canMove
- This is false if there's a security group limiting the subjects
that can move stems and this subject is not in the group.privs
- The naming privileges that the subject has on the stem.
public static boolean canCopyOtherStemToStem(Stem stem, boolean canCopy, Set<Privilege> privs)
canCopy
- This is false if there's a security group limiting the subjects
that can copy stems and this subject is not in the group.privs
- The naming privileges that the subject has on the specified stem.
public static boolean canMoveOtherStemToStem(Stem stem, boolean canMove, Set<Privilege> privs)
canMove
- This is false if there's a security group limiting the subjects
that can move stems and this subject is not in the group.privs
- The naming privileges that the subject has on the specified stem.
public static boolean canCopyGroupToStem(Stem stem, Set<Privilege> privs)
stem
- privs
- The naming privileges that the subject has on the stem.
public static boolean canMoveGroupToStem(Stem stem, Set<Privilege> privs)
stem
- privs
- The naming privileges that the subject has on the stem.
public static Group copyGroup(Group group, Stem destinationStem, String[] selections)
group
- destinationStem
- selections
-
public static void moveGroup(Group group, Stem destinationStem, String[] selections)
group
- destinationStem
- selections
- public static Stem copyStem(Stem stemToCopy, Stem destinationStem, String[] selections)
stemToCopy
- destinationStem
- selections
-
public static void moveStem(Stem stemToMove, Stem destinationStem, String[] selections)
stemToMove
- destinationStem
- selections
- public static String getMemberDisplayValue(Member member, ResourceBundle bundle)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |