|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectedu.internet2.middleware.grouper.GroupFinder
public class GroupFinder
Find groups within the Groups Registry.
Constructor Summary | |
---|---|
GroupFinder()
|
Method Summary | |
---|---|
static java.util.Set<Group> |
findAllByAttribute(GrouperSession s,
java.lang.String attr,
java.lang.String val)
Find Groups by attribute value. |
static java.util.Set<Group> |
findAllByType(GrouperSession s,
GroupType type)
Find all groups within the registry by their GroupType . |
static Group |
findByAlternateName(GrouperSession s,
java.lang.String name,
boolean exceptionIfNotFound)
Find a group within the registry by its alternate name. |
static Group |
findByAttribute(GrouperSession s,
java.lang.String attr,
java.lang.String val)
Deprecated. use the overload |
static Group |
findByAttribute(GrouperSession s,
java.lang.String attr,
java.lang.String val,
boolean exceptionOnNull)
Find Group by attribute value. |
static Group |
findByCurrentName(GrouperSession s,
java.lang.String name,
boolean exceptionIfNotFound)
Find a group within the registry by its current name. |
static Group |
findByName(GrouperSession s,
java.lang.String name)
Deprecated. |
static Group |
findByName(GrouperSession s,
java.lang.String name,
boolean exceptionIfNotFound)
Find a group within the registry by name. |
static Group |
findByName(GrouperSession s,
java.lang.String name,
boolean exceptionIfNotFound,
QueryOptions queryOptions)
Find a group within the registry by name. |
static Group |
findByUuid(GrouperSession s,
java.lang.String uuid)
Deprecated. |
static Group |
findByUuid(GrouperSession s,
java.lang.String uuid,
boolean exceptionIfNotFound)
Find a group within the registry by UUID. |
static Group |
findByUuid(GrouperSession s,
java.lang.String uuid,
boolean exceptionIfNotFound,
QueryOptions queryOptions)
Find a group within the registry by UUID. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GroupFinder()
Method Detail |
---|
@Deprecated public static Group findByAttribute(GrouperSession s, java.lang.String attr, java.lang.String val) throws GroupNotFoundException, java.lang.IllegalArgumentException
try { Group g = GroupFinder.findByAttribute(s, "description", "some value"); } catch (GroupNotFoundException eGNF) { }
s
- Search within this session context.attr
- Search on this attribute.val
- Search for this value.
Group
.
GroupNotFoundException
java.lang.IllegalArgumentException
public static Group findByAttribute(GrouperSession s, java.lang.String attr, java.lang.String val, boolean exceptionOnNull) throws GroupNotFoundException, java.lang.IllegalArgumentException
Group g = GroupFinder.findByAttribute(s, "description", "some value", true);
s
- Search within this session context.attr
- Search on this attribute.val
- Search for this value.exceptionOnNull
- true if there should be an exception on null
Group
.
GroupNotFoundException
java.lang.IllegalArgumentException
public static java.util.Set<Group> findAllByAttribute(GrouperSession s, java.lang.String attr, java.lang.String val) throws java.lang.IllegalArgumentException
Setgroups = GroupFinder.findAllByAttribute(s, "description", "some value");
s
- Search within this session context.attr
- Search on this attribute.val
- Search for this value.
Group
.
java.lang.IllegalArgumentException
@Deprecated public static Group findByName(GrouperSession s, java.lang.String name) throws GroupNotFoundException
try { Group g = GroupFinder.findByName(name); } catch (GroupNotFoundException e) { // Group not found }
s
- Find group within this session context.name
- Name of group to find.
Group
GroupNotFoundException
public static Group findByName(GrouperSession s, java.lang.String name, boolean exceptionIfNotFound) throws GroupNotFoundException
try { Group g = GroupFinder.findByName(name); } catch (GroupNotFoundException e) { // Group not found }
s
- Find group within this session context.name
- Name of group to find.exceptionIfNotFound
-
Group
GroupNotFoundException
public static Group findByName(GrouperSession s, java.lang.String name, boolean exceptionIfNotFound, QueryOptions queryOptions) throws GroupNotFoundException
try { Group g = GroupFinder.findByName(name); } catch (GroupNotFoundException e) { // Group not found }
s
- Find group within this session context.name
- Name of group to find.exceptionIfNotFound
- queryOptions
- paging, sorting, caching options
Group
GroupNotFoundException
public static Group findByCurrentName(GrouperSession s, java.lang.String name, boolean exceptionIfNotFound) throws GroupNotFoundException
try { Group g = GroupFinder.findByCurrentName(name, true); } catch (GroupNotFoundException e) { // Group not found }
s
- Find group within this session context.name
- Name of group to find.exceptionIfNotFound
-
Group
GroupNotFoundException
public static Group findByAlternateName(GrouperSession s, java.lang.String name, boolean exceptionIfNotFound) throws GroupNotFoundException
try { Group g = GroupFinder.findByAlternateName(name, true); } catch (GroupNotFoundException e) { // Group not found }
s
- Find group within this session context.name
- Name of group to find.exceptionIfNotFound
-
Group
GroupNotFoundException
public static java.util.Set<Group> findAllByType(GrouperSession s, GroupType type) throws java.lang.IllegalArgumentException
GroupType
. Or empty set if none (never null).
Setgroups = GroupFinder.findAllByType( s, GroupTypeFinder.find("your type") );
s
- Find group within this session context.type
- Find group with this GroupType
.
Group
s
java.lang.IllegalArgumentException
@Deprecated public static Group findByUuid(GrouperSession s, java.lang.String uuid) throws GroupNotFoundException
Group g = GroupFinder.findByUuid(s, uuid);
s
- Find group within this session context.uuid
- UUID of group to find.
Group
GroupNotFoundException
public static Group findByUuid(GrouperSession s, java.lang.String uuid, boolean exceptionIfNotFound) throws GroupNotFoundException
Group g = GroupFinder.findByUuid(s, uuid);
s
- Find group within this session context.uuid
- UUID of group to find.exceptionIfNotFound
- true if exception if not found
Group
GroupNotFoundException
- if not found an exceptionIfNotFound is truepublic static Group findByUuid(GrouperSession s, java.lang.String uuid, boolean exceptionIfNotFound, QueryOptions queryOptions) throws GroupNotFoundException
Group g = GroupFinder.findByUuid(s, uuid);
s
- Find group within this session context.uuid
- UUID of group to find.exceptionIfNotFound
- true if exception if not foundqueryOptions
-
Group
GroupNotFoundException
- if not found an exceptionIfNotFound is true
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |