Package edu.internet2.middleware.subject

Class LazySource

java.lang.Object

edu.internet2.middleware.subject.LazySource

All Implemented Interfaces:

Source, Serializable

public class LazySource
extends Object
implements Source, Serializable

if the id or sources might not be known, dont resolve until you need it

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LazySource()	default constructor
LazySource(String theSourceId)	construct with source id

Method Summary

Modifier and Type	Method	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. from the subject.properties
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.
Source	getSource()
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<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.
String	getUnderlyingSourceId()	id of underlying source
void	init()	Called by SourceManager when it loads this source.
Properties	initParams()	get the init params e.g. from the subject.properties
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	setUnderlyingSourceId(String sourceId1)	id of underlying source

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LazySource

public LazySource()

default constructor

LazySource

public LazySource(String theSourceId)

construct with source id

Parameters:

theSourceId -

Method Details

loggingStart

public void loggingStart()

Description copied from interface: Source

start logging the source low level actions

Specified by:

loggingStart in interface Source

loggingStop

public String loggingStop()

Description copied from interface: Source

stop logging and get the output

Specified by:

loggingStop in interface Source

retrieveAllSubjectIds

public Set<String> retrieveAllSubjectIds()

Description copied from interface: Source

get all subject ids

Specified by:

retrieveAllSubjectIds in interface Source

Returns:

all subjectIds

See Also:

• Source.retrieveAllSubjectIds()

getSubjectStatusConfig

public SubjectStatusConfig getSubjectStatusConfig()

Description copied from interface: Source

get the config bean for this source

Specified by:

getSubjectStatusConfig in interface Source

Returns:

the config bean for this source

See Also:

• Source.getSubjectStatusConfig()

getUnderlyingSourceId

public String getUnderlyingSourceId()

id of underlying source

Returns:

the sourceId

setUnderlyingSourceId

public void setUnderlyingSourceId(String sourceId1)

id of underlying source

Parameters:

sourceId1 - the sourceId to set

getSource

public Source getSource()

Returns:

source

checkConfig

public void checkConfig()

Description copied from interface: Source

make sure the config is ok, and log descriptive errors if not

Specified by:

checkConfig in interface Source

See Also:

• Source.checkConfig()

getId

public String getId()

Description copied from interface: Source

Returns the ID of this source.

Specified by:

getId in interface Source

Returns:

id

See Also:

• Source.getId()

getName

public String getName()

Description copied from interface: Source

Returns the name of this source.

Specified by:

getName in interface Source

Returns:

name

See Also:

• Source.getName()

getSubject

public Subject getSubject(String id)
                   throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

Parameters:

id -

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

getSubject

public Subject getSubject(String id,
 boolean exceptionIfNull)
                   throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

exceptionIfNull - if SubjectNotFoundException should be throws if the subject is null, or if null should be returned

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubject(java.lang.String, boolean)

getSubjectByIdOrIdentifier

public Subject getSubjectByIdOrIdentifier(String idOrIdentifier,
 boolean exceptionIfNull)
                                   throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

find by id or identifier. pass in either an id or an identifier

Specified by:

getSubjectByIdOrIdentifier in interface Source

exceptionIfNull - if SubjectNotFoundException or null

Returns:

the subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubjectByIdOrIdentifier(java.lang.String, boolean)

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String id)
                               throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID.

Specified by:

getSubjectByIdentifier in interface Source

Parameters:

id -

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String id,
 boolean exceptionIfNull)
                               throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID.

Specified by:

getSubjectByIdentifier in interface Source

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubjectByIdentifier(java.lang.String, boolean)

getSubjectTypes

public Set<SubjectType> getSubjectTypes()

Description copied from interface: Source

Gets the SubjectTypes supported by this source.

Specified by:

getSubjectTypes in interface Source

Returns:

set

See Also:

• Source.getSubjectTypes()

getSubjectsByIdentifiers

public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers)

Description copied from interface: Source

Get subjects by identifiers. Note, if the subjects arent found or arent unique, they wont be returned. Identifiers are unique ways to refer to a subject that isnt its id (e.g. netid). Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIdentifiers in interface Source

Returns:

a map of results never null indexed by the identifiers

See Also:

• Source.getSubjectsByIdentifiers(java.util.Collection)

getSubjectsByIds

public Map<String,Subject> getSubjectsByIds(Collection<String> ids)

Description copied from interface: Source

Get subjects by ids. Note, if the subjects arent found or arent unique, they wont be returned. Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIds in interface Source

Returns:

a map of results never null indexed by the id

See Also:

• Source.getSubjectsByIds(java.util.Collection)

getSubjectsByIdsOrIdentifiers

public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers)

Description copied from interface: Source

Get subjects by ids or identifiers. Note, if the subjects arent found or arent unique, they wont be returned. Identifiers are unique ways to refer to a subject that isnt its id (e.g. netid). Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIdsOrIdentifiers in interface Source

Parameters:

idsOrIdentifiers - each string could be a subject id or identifier

Returns:

a map of results never null indexed by the id or identifier that was passed in. Note, the same subject could be returned twice if looked up by id and identifier (two inputs)

See Also:

• Source.getSubjectsByIdsOrIdentifiers(java.util.Collection)

init

public void init()
          throws SourceUnavailableException

Description copied from interface: Source

Called by SourceManager when it loads this source.

Specified by:

init in interface Source

Throws:

SourceUnavailableException

See Also:

• Source.init()

printConfig

public String printConfig()

Description copied from interface: Source

in the startup on this i2mi app, print helpful and brief info about this source

Specified by:

printConfig in interface Source

Returns:

the info

See Also:

• Source.printConfig()

searchPage

public SearchPageResult searchPage(String searchValue)

Description copied from interface: Source

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions if maxPageSize is set in subject.properties, then only return max that many, and if there are more, set the tooManyResults flag

Specified by:

searchPage in interface Source

Returns:

results and if there are too many, never return null!!!

See Also:

• Source.searchPage(java.lang.String)

search

public Set<Subject> search(String searchValue)

Description copied from interface: Source

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions

Specified by:

search in interface Source

Returns:

set

See Also:

• Source.search(java.lang.String)

setId

public void setId(String id)

Description copied from interface: Source

Sets the ID of this source.

Specified by:

setId in interface Source

See Also:

• Source.setId(java.lang.String)

setName

public void setName(String name)

Description copied from interface: Source

Sets the name of this source.

Specified by:

setName in interface Source

See Also:

• Source.setName(java.lang.String)

getInitParam

public String getInitParam(String name1)

Description copied from interface: Source

get the init param e.g. from the subject.properties

Specified by:

getInitParam in interface Source

Returns:

param

See Also:

• Source.getInitParam(java.lang.String)

initParams

public Properties initParams()

Description copied from interface: Source

get the init params e.g. from the subject.properties

Specified by:

initParams in interface Source

Returns:

params

See Also:

• edu.internet2.middleware.subject.Source#getInitParams()

getSearchAttributes

public Map<Integer,String> getSearchAttributes()

Description copied from interface: Source

Get the names of attributes used for searching.

Specified by:

getSearchAttributes in interface Source

Returns:

search attributes in lower case

See Also:

• Source.getSearchAttributes()

getSubjectIdentifierAttributes

public Map<Integer,String> getSubjectIdentifierAttributes()

Description copied from interface: Source

Get the names of attributes that are subject identifiers. This only returns the first

Specified by:

getSubjectIdentifierAttributes in interface Source

Returns:

subject identifiers

See Also:

• Source.getSubjectIdentifierAttributes()

getSubjectIdentifierAttributesAll

public Map<Integer,String> getSubjectIdentifierAttributesAll()

Description copied from interface: Source

Get all the names of attributes that are subject identifiers.

Specified by:

getSubjectIdentifierAttributesAll in interface Source

Returns:

subject identifiers

See Also:

• Source.getSubjectIdentifierAttributesAll()

getSortAttributes

public Map<Integer,String> getSortAttributes()

Description copied from interface: Source

Get the names of attributes used for sorting.

Specified by:

getSortAttributes in interface Source

Returns:

sort attributes in lower case

See Also:

• Source.getSortAttributes()

getInternalAttributes

public Set<String> getInternalAttributes()

Description copied from interface: Source

Get a set of attributes that are marked as being internal attributes. Note, these will be in lower case

Specified by:

getInternalAttributes in interface Source

Returns:

set to lower case

See Also:

• Source.getInternalAttributes()

getSubject

public Subject getSubject(String id,
 boolean exceptionIfNull,
 String realm)
                   throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

exceptionIfNull - if SubjectNotFoundException should be throws if the subject is null, or if null should be returned

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubject(java.lang.String, boolean, java.lang.String)

getSubjectByIdOrIdentifier

public Subject getSubjectByIdOrIdentifier(String idOrIdentifier,
 boolean exceptionIfNull,
 String realm)
                                   throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

find by id or identifier. pass in either an id or an identifier

Specified by:

getSubjectByIdOrIdentifier in interface Source

exceptionIfNull - if SubjectNotFoundException or null

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

the subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubjectByIdOrIdentifier(java.lang.String, boolean, java.lang.String)

getSubjectByIdentifier

public Subject getSubjectByIdentifier(String id,
 boolean exceptionIfNull,
 String realm)
                               throws SubjectNotFoundException,
SubjectNotUniqueException

Description copied from interface: Source

Gets a Subject by other well-known identifiers, aside from the subject ID, for example, login ID.

Specified by:

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 user

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

• Source.getSubjectByIdentifier(java.lang.String, boolean, java.lang.String)

getSubjectsByIdentifiers

public Map<String,Subject> getSubjectsByIdentifiers(Collection<String> identifiers,
 String realm)

Description copied from interface: Source

Get subjects by identifiers. Note, if the subjects arent found or arent unique, they wont be returned. Identifiers are unique ways to refer to a subject that isnt its id (e.g. netid). Duplicates are ok on the input, but will return one output.

Specified by:

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 user

Returns:

a map of results never null indexed by the identifiers

See Also:

• Source.getSubjectsByIdentifiers(java.util.Collection, java.lang.String)

getSubjectsByIds

public Map<String,Subject> getSubjectsByIds(Collection<String> ids,
 String realm)

Description copied from interface: Source

Get subjects by ids. Note, if the subjects arent found or arent unique, they wont be returned. Duplicates are ok on the input, but will return one output.

Specified by:

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 user

Returns:

a map of results never null indexed by the id

See Also:

• Source.getSubjectsByIds(java.util.Collection, java.lang.String)

getSubjectsByIdsOrIdentifiers

public Map<String,Subject> getSubjectsByIdsOrIdentifiers(Collection<String> idsOrIdentifiers,
 String realm)

Description copied from interface: Source

Get subjects by ids or identifiers. Note, if the subjects arent found or arent unique, they wont be returned. Identifiers are unique ways to refer to a subject that isnt its id (e.g. netid). Duplicates are ok on the input, but will return one output.

Specified by:

getSubjectsByIdsOrIdentifiers in interface Source

Parameters:

idsOrIdentifiers - each string could be a subject id or identifier

realm - string value that sets the realm for the search. The source can implement various realms to account for permissions of the calling user

Returns:

a map of results never null indexed by the id or identifier that was passed in. Note, the same subject could be returned twice if looked up by id and identifier (two inputs)

See Also:

• Source.getSubjectsByIdsOrIdentifiers(java.util.Collection, java.lang.String)

search

public Set<Subject> search(String searchValue,
 String realm)

Description copied from interface: Source

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions

Specified by:

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 user

Returns:

set

See Also:

• Source.search(java.lang.String, java.lang.String)

searchPage

public SearchPageResult searchPage(String searchValue,
 String realm)

Description copied from interface: Source

Unstructured search for Subjects. Each implementation utilizes its own search algorithm tailored to the Subject repository and schema. Note if config param: throwErrorOnFindAllFailure is false, then swallow and log exceptions if maxPageSize is set in subject.properties, then only return max that many, and if there are more, set the tooManyResults flag

Specified by:

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 user

Returns:

results and if there are too many, never return null!!!

See Also:

• Source.searchPage(java.lang.String, java.lang.String)

isEditable

public boolean isEditable()

Specified by:

isEditable in interface Source

Returns:

true if the source is editable otherwise false

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Source

Returns:

true if the source is active otherwise false

getConfigId

public String getConfigId()

Specified by:

getConfigId in interface Source

Returns:

configId for this source

setConfigId

public void setConfigId(String configId)

Description copied from interface: Source

set config id for this source

Specified by:

setConfigId in interface Source

convertSubjectAttributeToSourceAttribute

public String convertSubjectAttributeToSourceAttribute(String nameOfSubjectAttribute)

Specified by:

convertSubjectAttributeToSourceAttribute in interface Source

convertSourceAttributeToSubjectAttribute

public String convertSourceAttributeToSubjectAttribute(String nameOfSourceAttribute)

Specified by:

convertSourceAttributeToSubjectAttribute in interface Source