public class LazySource extends Object implements Source, Serializable
Constructor and Description |
---|
LazySource()
default constructor
|
LazySource(String theSourceId)
construct with source id
|
Modifier and Type | Method and Description |
---|---|
void |
checkConfig()
make sure the config is ok, and log descriptive errors if not
|
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)
Gets a Subject by its ID.
|
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)
Gets a Subject by other well-known identifiers, aside
from the subject ID, for example, login ID.
|
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<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.
|
String |
getUnderlyingSourceId()
id of underlying source
|
void |
init()
Called by SourceManager when it loads this source.
|
Properties |
initParams()
get the init params e.g.
|
String |
printConfig()
in the startup on this i2mi app, print helpful and brief info about this source
|
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 |
setId(String id)
Sets the ID of this source.
|
void |
setName(String name)
Sets the name of this source.
|
void |
setUnderlyingSourceId(String sourceId1)
id of underlying source
|
public LazySource()
public LazySource(String theSourceId)
theSourceId
- public SubjectStatusConfig getSubjectStatusConfig()
Source
getSubjectStatusConfig
in interface Source
Source.getSubjectStatusConfig()
public String getUnderlyingSourceId()
public void setUnderlyingSourceId(String sourceId1)
sourceId1
- the sourceId to setpublic void checkConfig()
Source
checkConfig
in interface Source
Source.checkConfig()
public String getId()
Source
getId
in interface Source
Source.getId()
public String getName()
Source
getName
in interface Source
Source.getName()
public Subject getSubject(String id) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubject
in interface Source
id
- SubjectNotFoundException
SubjectNotUniqueException
public Subject getSubject(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubject
in interface Source
exceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returnedSubjectNotFoundException
SubjectNotUniqueException
Source.getSubject(java.lang.String, boolean)
public Subject getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdOrIdentifier
in interface Source
exceptionIfNull
- if SubjectNotFoundException or nullSubjectNotFoundException
SubjectNotUniqueException
Source.getSubjectByIdOrIdentifier(java.lang.String, boolean)
public Subject getSubjectByIdentifier(String id) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdentifier
in interface Source
id
- SubjectNotFoundException
SubjectNotUniqueException
public Subject getSubjectByIdentifier(String id, boolean exceptionIfNull) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdentifier
in interface Source
SubjectNotFoundException
SubjectNotUniqueException
Source.getSubjectByIdentifier(java.lang.String, boolean)
public Set<SubjectType> getSubjectTypes()
Source
getSubjectTypes
in interface Source
Source.getSubjectTypes()
public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)
Source
getSubjectsByIdentifiers
in interface Source
Source.getSubjectsByIdentifiers(java.util.Collection)
public Map<String,Subject> getSubjectsByIds(Collection<String> ids)
Source
getSubjectsByIds
in interface Source
Source.getSubjectsByIds(java.util.Collection)
public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)
Source
getSubjectsByIdsOrIdentifiers
in interface Source
idsOrIdentifiers
- each string could be a subject id or identifierSource.getSubjectsByIdsOrIdentifiers(java.util.Collection)
public void init() throws SourceUnavailableException
Source
init
in interface Source
SourceUnavailableException
Source.init()
public String printConfig()
Source
printConfig
in interface Source
Source.printConfig()
public SearchPageResult searchPage(String searchValue)
Source
searchPage
in interface Source
Source.searchPage(java.lang.String)
public Set<Subject> search(String searchValue)
Source
search
in interface Source
Source.search(java.lang.String)
public void setId(String id)
Source
setId
in interface Source
Source.setId(java.lang.String)
public void setName(String name)
Source
setName
in interface Source
Source.setName(java.lang.String)
public String getInitParam(String name1)
Source
getInitParam
in interface Source
Source.getInitParam(java.lang.String)
public Properties initParams()
Source
initParams
in interface Source
edu.internet2.middleware.subject.Source#getInitParams()
public Map<Integer,String> getSearchAttributes()
Source
getSearchAttributes
in interface Source
Source.getSearchAttributes()
public Map<Integer,String> getSortAttributes()
Source
getSortAttributes
in interface Source
Source.getSortAttributes()
public Set<String> getInternalAttributes()
Source
getInternalAttributes
in interface Source
Source.getInternalAttributes()
public Subject getSubject(String id, boolean exceptionIfNull, String realm) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubject
in interface Source
exceptionIfNull
- if SubjectNotFoundException should be
throws if the subject is null, or if null should be returnedrealm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSubjectNotFoundException
SubjectNotUniqueException
Source.getSubject(java.lang.String, boolean, java.lang.String)
public Subject getSubjectByIdOrIdentifier(String idOrIdentifier, boolean exceptionIfNull, String realm) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdOrIdentifier
in interface Source
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
Source.getSubjectByIdOrIdentifier(java.lang.String, boolean, java.lang.String)
public Subject getSubjectByIdentifier(String id, boolean exceptionIfNull, String realm) throws SubjectNotFoundException, SubjectNotUniqueException
Source
getSubjectByIdentifier
in interface Source
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
Source.getSubjectByIdentifier(java.lang.String, boolean, java.lang.String)
public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers, String realm)
Source
getSubjectsByIdentifiers
in interface Source
realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSource.getSubjectsByIdentifiers(java.util.Collection, java.lang.String)
public Map<String,Subject> getSubjectsByIds(Collection<String> ids, String realm)
Source
getSubjectsByIds
in interface Source
realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSource.getSubjectsByIds(java.util.Collection, java.lang.String)
public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers, String realm)
Source
getSubjectsByIdsOrIdentifiers
in interface Source
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 userSource.getSubjectsByIdsOrIdentifiers(java.util.Collection, java.lang.String)
public Set<Subject> search(String searchValue, String realm)
Source
search
in interface Source
realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSource.search(java.lang.String, java.lang.String)
public SearchPageResult searchPage(String searchValue, String realm)
Source
searchPage
in interface Source
realm
- string value that sets the realm for the search. The source can
implement various realms to account for permissions of the calling userSource.searchPage(java.lang.String, java.lang.String)
Copyright © 2016 Internet2. All rights reserved.