|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectedu.internet2.middleware.subject.provider.BaseSourceAdapter
edu.internet2.middleware.grouper.GrouperSourceAdapter
public class GrouperSourceAdapter
Source adapter for using Grouper groups as I2MI Subjects.
This is an adapter I2MI Subjects of type group. It allows groups within a Group Groups Registry to be referenced as I2MI Subjects.
To use, add the following to your sources.xml file:
<source adapterClass="edu.internet2.middleware.grouper.GrouperSourceAdapter"> <id>g:gsa</id> <name>Grouper: Grouper Source Adapter</name> <type>group</type> </source>
| Field Summary | |
|---|---|
static boolean |
failOnSearchForTesting
for testing if we should fail on testing |
| Constructor Summary | |
|---|---|
GrouperSourceAdapter()
Allocates new GrouperSourceAdapter. |
|
GrouperSourceAdapter(java.lang.String id,
java.lang.String name)
Allocates new GrouperSourceAdapter. |
|
| Method Summary | |
|---|---|
void |
checkConfig()
|
java.lang.Integer |
getMaxPage()
max Page size |
edu.internet2.middleware.subject.Subject |
getSubject(java.lang.String id)
Deprecated. |
edu.internet2.middleware.subject.Subject |
getSubject(java.lang.String id,
boolean exceptionIfNotFound)
Get a Group subject by UUID. |
edu.internet2.middleware.subject.Subject |
getSubjectByIdentifier(java.lang.String name)
Deprecated. |
edu.internet2.middleware.subject.Subject |
getSubjectByIdentifier(java.lang.String name,
boolean exceptionIfNull)
Gets a Group subject by its name. |
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
getSubjectsByIdentifiers(java.util.Collection<java.lang.String> identifiers)
|
java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> |
getSubjectsByIds(java.util.Collection<java.lang.String> ids)
|
java.util.Set |
getSubjectTypes()
Gets the SubjectTypes supported by this source. |
void |
init()
Initializes the Grouper source adapter. |
static GrouperSession |
internal_getSessionOrRootForSubjectFinder()
|
java.lang.String |
printConfig()
|
java.util.Set<edu.internet2.middleware.subject.Subject> |
search(java.lang.String searchValue)
|
edu.internet2.middleware.subject.SearchPageResult |
searchPage(java.lang.String searchValue)
|
java.util.Set<TypeOfGroup> |
typeOfGroups()
type of groups to search on |
| Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter |
|---|
addAttribute, addInitParam, addInternalAttribute, addSubjectType, equals, getId, getInitParam, getInitParams, getInternalAttributes, getName, getSearchAttributes, getSortAttributes, getSubjectByIdOrIdentifier, getSubjectsByIdsOrIdentifiers, getSubjectStatusConfig, getSubjectType, hashCode, loadSearch, removeInitParam, resultSetLimit, setId, setName, setSearchAttributes, setSortAttributes |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static boolean failOnSearchForTesting
| Constructor Detail |
|---|
public GrouperSourceAdapter()
public GrouperSourceAdapter(java.lang.String id,
java.lang.String name)
id - name - | Method Detail |
|---|
@Deprecated
public edu.internet2.middleware.subject.Subject getSubject(java.lang.String id)
throws edu.internet2.middleware.subject.SubjectNotFoundException
Group subject by UUID.
// Use it within the Grouper API
try {
Subject subj = SubjectFinder.getSubject(uuid, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
// Use it directly
try {
Subject subj = source.getSubject(uuid, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
getSubject in interface edu.internet2.middleware.subject.SourcegetSubject in class edu.internet2.middleware.subject.provider.BaseSourceAdapterid - Group UUID
Subject
edu.internet2.middleware.subject.SubjectNotFoundException
public edu.internet2.middleware.subject.Subject getSubject(java.lang.String id,
boolean exceptionIfNotFound)
throws edu.internet2.middleware.subject.SubjectNotFoundException
Group subject by UUID.
// Use it within the Grouper API
try {
Subject subj = SubjectFinder.getSubject(uuid, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
// Use it directly
try {
Subject subj = source.getSubject(uuid, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
getSubject in interface edu.internet2.middleware.subject.SourcegetSubject in class edu.internet2.middleware.subject.provider.BaseSourceAdapterid - Group UUIDexceptionIfNotFound -
Subject
edu.internet2.middleware.subject.SubjectNotFoundException
@Deprecated
public edu.internet2.middleware.subject.Subject getSubjectByIdentifier(java.lang.String name)
throws edu.internet2.middleware.subject.SubjectNotFoundException
Group subject by its name.
// Use it within the Grouper API
try {
Subject subj = SubjectFinder.getSubjectByIdentifier(name, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
// Use it directly
try {
Subject subj = source.getSubjectByIdentifier(name, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
getSubjectByIdentifier in interface edu.internet2.middleware.subject.SourcegetSubjectByIdentifier in class edu.internet2.middleware.subject.provider.BaseSourceAdaptername - Group name
Subject
edu.internet2.middleware.subject.SubjectNotFoundExceptionpublic java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> getSubjectsByIdentifiers(java.util.Collection<java.lang.String> identifiers)
getSubjectsByIdentifiers in interface edu.internet2.middleware.subject.SourcegetSubjectsByIdentifiers in class edu.internet2.middleware.subject.provider.BaseSourceAdapterSource.getSubjectsByIdentifiers(Collection)public java.util.Map<java.lang.String,edu.internet2.middleware.subject.Subject> getSubjectsByIds(java.util.Collection<java.lang.String> ids)
getSubjectsByIds in interface edu.internet2.middleware.subject.SourcegetSubjectsByIds in class edu.internet2.middleware.subject.provider.BaseSourceAdapterSource.getSubjectsByIds(Collection)
public edu.internet2.middleware.subject.Subject getSubjectByIdentifier(java.lang.String name,
boolean exceptionIfNull)
throws edu.internet2.middleware.subject.SubjectNotFoundException
Group subject by its name.
// Use it within the Grouper API
try {
Subject subj = SubjectFinder.getSubjectByIdentifier(name, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
// Use it directly
try {
Subject subj = source.getSubjectByIdentifier(name, "group");
}
catch (SubjectNotFoundException e) {
// Subject not found
}
getSubjectByIdentifier in interface edu.internet2.middleware.subject.SourcegetSubjectByIdentifier in class edu.internet2.middleware.subject.provider.BaseSourceAdaptername - Group nameexceptionIfNull -
Subject
edu.internet2.middleware.subject.SubjectNotFoundExceptionpublic java.util.Set getSubjectTypes()
SourceAdapter sa = new GrouperSourceAdapter(); Set types = sa.getSubjectTypes();
getSubjectTypes in interface edu.internet2.middleware.subject.SourcegetSubjectTypes in class edu.internet2.middleware.subject.provider.BaseSourceAdapter
public void init()
throws edu.internet2.middleware.subject.SourceUnavailableException
No initialization is currently performed by this adapter.
init in interface edu.internet2.middleware.subject.Sourceinit in class edu.internet2.middleware.subject.provider.BaseSourceAdapteredu.internet2.middleware.subject.SourceUnavailableExceptionpublic java.util.Set<TypeOfGroup> typeOfGroups()
public static GrouperSession internal_getSessionOrRootForSubjectFinder()
public void checkConfig()
Source.checkConfig()public java.lang.String printConfig()
Source.printConfig()public java.lang.Integer getMaxPage()
public java.util.Set<edu.internet2.middleware.subject.Subject> search(java.lang.String searchValue)
search in interface edu.internet2.middleware.subject.Sourcesearch in class edu.internet2.middleware.subject.provider.BaseSourceAdapterpublic edu.internet2.middleware.subject.SearchPageResult searchPage(java.lang.String searchValue)
searchPage in interface edu.internet2.middleware.subject.SourcesearchPage in class edu.internet2.middleware.subject.provider.BaseSourceAdapterBaseSourceAdapter.searchPage(java.lang.String)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||