public interface Source
Modifier and Type | Method and Description |
---|---|
void |
checkConfig()
make sure the config is ok, and log descriptive errors if not
|
String |
convertSourceAttributeToSubjectAttribute(String nameOfSourceAttribute) |
String |
convertSubjectAttributeToSourceAttribute(String nameOfSubjectAttribute) |
String |
getConfigId() |
String |
getId()
Returns the ID of this source.
|
String |
getInitParam(String name1)
get the init param e.g.
|
Set<String> |
getInternalAttributes()
Get a set of attributes that are marked as being internal attributes.
|
String |
getName()
Returns the name of this source.
|
Map<Integer,String> |
getSearchAttributes()
Get the names of attributes used for searching.
|
Map<Integer,String> |
getSortAttributes()
Get the names of attributes used for sorting.
|
Subject |
getSubject(String id)
Deprecated.
use the overload instead
|
Subject |
getSubject(String id,
boolean exceptionIfNull)
Gets a Subject by its ID.
|
Subject |
getSubject(String id,
boolean exceptionIfNull,
String realm)
Gets a Subject by its ID.
|
Subject |
getSubjectByIdentifier(String id)
Deprecated.
use the overload instead
|
Subject |
getSubjectByIdentifier(String id,
boolean exceptionIfNull)
Gets a Subject by other well-known identifiers, aside
from the subject ID, for example, login ID.
|
Subject |
getSubjectByIdentifier(String id,
boolean exceptionIfNull,
String realm)
Gets a Subject by other well-known identifiers, aside
from the subject ID, for example, login ID.
|
Subject |
getSubjectByIdOrIdentifier(String idOrIdentifier,
boolean exceptionIfNull)
find by id or identifier.
|
Subject |
getSubjectByIdOrIdentifier(String idOrIdentifier,
boolean exceptionIfNull,
String realm)
find by id or identifier.
|
Map<Integer,String> |
getSubjectIdentifierAttributes()
Get the names of attributes that are subject identifiers.
|
Map<Integer,String> |
getSubjectIdentifierAttributesAll()
Get all the names of attributes that are subject identifiers.
|
Map<String,Subject> |
getSubjectsByIdentifiers(Collection<String> identifiers)
Get subjects by identifiers.
|
Map<String,Subject> |
getSubjectsByIdentifiers(Collection<String> identifiers,
String realm)
Get subjects by identifiers.
|
Map<String,Subject> |
getSubjectsByIds(Collection<String> ids)
Get subjects by ids.
|
Map<String,Subject> |
getSubjectsByIds(Collection<String> ids,
String realm)
Get subjects by ids.
|
Map<String,Subject> |
getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Get subjects by ids or identifiers.
|
Map<String,Subject> |
getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
String realm)
Get subjects by ids or identifiers.
|
SubjectStatusConfig |
getSubjectStatusConfig()
get the config bean for this source
|
Set<SubjectType> |
getSubjectTypes()
Gets the SubjectTypes supported by this source.
|
void |
init()
Called by SourceManager when it loads this source.
|
Properties |
initParams()
get the init params e.g.
|
boolean |
isEditable() |
boolean |
isEnabled() |
void |
loggingStart()
start logging the source low level actions
|
String |
loggingStop()
stop logging and get the output
|
String |
printConfig()
in the startup on this i2mi app, print helpful and brief info about this source
|
Set<String> |
retrieveAllSubjectIds()
get all subject ids
|
Set<Subject> |
search(String searchValue)
Unstructured search for Subjects.
|
Set<Subject> |
search(String searchValue,
String realm)
Unstructured search for Subjects.
|
SearchPageResult |
searchPage(String searchValue)
Unstructured search for Subjects.
|
SearchPageResult |
searchPage(String searchValue,
String realm)
Unstructured search for Subjects.
|
void |
setConfigId(String configId)
set config id for this source
|
void |
setId(String id)
Sets the ID of this source.
|
void |
setName(String name)
Sets the name of this source.
|
void loggingStart()
String loggingStop()
Set<String> retrieveAllSubjectIds()
UnsupportedOperationException
- if not implementedSubjectStatusConfig getSubjectStatusConfig()
String getId()
void setId(String id)
id
- String getName()
void setName(String name)
name
- Set<SubjectType> getSubjectTypes()
@Deprecated Subject getSubject(String id) throws SubjectNotFoundException, SubjectNotUniqueException
id
- SubjectNotFoundException
SubjectNotUniqueException
@Deprecated Subject getSubjectByIdentifier(String id) throws SubjectNotFoundException, SubjectNotUniqueException
id
- SubjectNotFoundException
SubjectNotUniqueException
Subject getSubject(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
id
- exceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returnedSubjectNotFoundException
SubjectNotUniqueException
Map<String,Subject> getSubjectsByIds(Collection<String> ids)
ids
- Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)
identifiers
- Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
idsOrIdentifiers
- each string could be a subject id or identifierSubject getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
idOrIdentifier
- exceptionIfNull
- if SubjectNotFoundException or nullSubjectNotFoundException
SubjectNotUniqueException
Subject getSubjectByIdentifier(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
id
- exceptionIfNull
- SubjectNotFoundException
SubjectNotUniqueException
Set<Subject> search(String searchValue)
searchValue
- void init() throws SourceUnavailableException
SourceUnavailableException
void checkConfig()
String printConfig()
String getInitParam(String name1)
name1
- Properties initParams()
Set<String> getInternalAttributes()
Map<Integer,String> getSubjectIdentifierAttributes()
Map<Integer,String> getSubjectIdentifierAttributesAll()
Map<Integer,String> getSortAttributes()
Map<Integer,String> getSearchAttributes()
SearchPageResult searchPage(String searchValue)
searchValue
- SearchPageResult searchPage(String searchValue, String realm)
realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling usersearchValue
- Subject getSubject(String id, boolean exceptionIfNull, String realm) throws SubjectNotFoundException, SubjectNotUniqueException
id
- realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userexceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returnedSubjectNotFoundException
SubjectNotUniqueException
Subject getSubjectByIdentifier(String id, boolean exceptionIfNull, String realm) throws SubjectNotFoundException, SubjectNotUniqueException
id
- exceptionIfNull
- realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSubjectNotFoundException
SubjectNotUniqueException
Subject getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull, String realm) throws SubjectNotFoundException, SubjectNotUniqueException
idOrIdentifier
- exceptionIfNull
- if SubjectNotFoundException or nullrealm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSubjectNotFoundException
SubjectNotUniqueException
Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers, String realm)
identifiers
- realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userMap<String,Subject> getSubjectsByIds(Collection<String> ids, String realm)
ids
- realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userMap<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, String realm)
idsOrIdentifiers
- each string could be a subject id or identifierrealm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSet<Subject> search(String searchValue, String realm)
searchValue
- realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userboolean isEditable()
boolean isEnabled()
String getConfigId()
void setConfigId(String configId)
String convertSubjectAttributeToSourceAttribute(String nameOfSubjectAttribute)
Copyright © 2016 Internet2. All rights reserved.