edu.internet2.middleware.subject.provider

Class LdapSourceAdapter

java.lang.Object

edu.internet2.middleware.subject.provider.BaseSourceAdapter

edu.internet2.middleware.subject.provider.LdapSourceAdapter

All Implemented Interfaces:

Source

Direct Known Subclasses:

GrouperLdapSourceAdapter2_5, HelperGrouperJndiSourceAdapter, JNDISourceAdapter

public class LdapSourceAdapter
extends BaseSourceAdapter

Ldap source adapter.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	subjectIDAttributeName
protected boolean	subjectIDFormatToLowerCase

Fields inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter

attributes, descriptionAttributeName, id, internalAttributes, name, nameAttributeName, params, searchAttributes, searches, sortAttributes, subjectIdentifierAttributes, subjectIdentifierAttributesAll, type, types

Constructor Summary

Constructors

Constructor and Description
LdapSourceAdapter()
LdapSourceAdapter(String id, String name)

Method Summary

Modifier and Type	Method and Description
void	checkConfig() make sure the config is ok, and log descriptive errors if not
Subject	createSubject(LdapEntry entry)
protected String	escapeSearchFilter(String filter) Escape a search filter to prevent LDAP injection.
protected Map<String,Set<String>>	getAllAttributes(SubjectImpl subject) Try to get more attributes for the subject.
protected Iterator<LdapEntry>	getLdapResults(Search search, String searchValue, String[] attributeNames)
protected LdapEntry	getLdapUnique(Search search, String searchValue, String[] attributeNames)
Integer	getMaxPage() max Page size
protected String	getNeededProperty(Properties props, String prop)
Subject	getSubject(String id) Deprecated.
Subject	getSubject(String id, boolean exceptionIfNull) Gets a Subject by its ID.
Subject	getSubjectByIdentifier(String id) Deprecated.
Subject	getSubjectByIdentifier(String id, boolean exceptionIfNull) note, you should implement this method since this implementation will become abstract at some point
void	init() Called by SourceManager when it loads this source.
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<Subject>	search(String searchValue) Unstructured search for Subjects.
SearchPageResult	searchPage(String searchValue) Unstructured search for Subjects.
void	setMultipleResults(boolean multipleResults) Set whether or not multiple results are allowed.
static <T> T[]	toArray(Collection collection, Class<T> theClass) convert a list into an array of type of theClass

Methods inherited from class edu.internet2.middleware.subject.provider.BaseSourceAdapter

addAttribute, addInitParam, addInternalAttribute, addSubjectType, convertSourceAttributeToSubjectAttribute, convertSubjectAttributeToSourceAttribute, createSubject, equals, getAttributes, getConfigId, getId, getInitParam, getInternalAttributes, getName, getSearch, getSearchAttributes, getSearches, getSortAttributes, getSourceAttributesToLowerCase, getSubject, getSubjectByIdentifier, getSubjectByIdOrIdentifier, getSubjectByIdOrIdentifier, getSubjectIdentifierAttributes, getSubjectIdentifierAttributesAll, getSubjectsByIdentifiers, getSubjectsByIdentifiers, getSubjectsByIds, getSubjectsByIds, getSubjectsByIdsOrIdentifiers, getSubjectsByIdsOrIdentifiers, getSubjectStatusConfig, getSubjectType, getSubjectTypes, hashCode, initParams, isEditable, isEnabled, loadSearch, removeInitParam, resultSetLimit, retrieveAllSubjectIds, search, searchPage, setConfigId, setId, setName, setSearchAttributes, setSearches, setSortAttributes, setSubjectIdentifierAttributes

Methods inherited from class java.lang.Object

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

Field Detail

subjectIDAttributeName

protected String subjectIDAttributeName

subjectIDFormatToLowerCase

protected boolean subjectIDFormatToLowerCase

Constructor Detail

LdapSourceAdapter

public LdapSourceAdapter()

LdapSourceAdapter

public LdapSourceAdapter(String id,
                         String name)

Parameters:

id -

name -

Method Detail

loggingStart

public void loggingStart()

Description copied from interface: Source

start logging the source low level actions

loggingStop

public String loggingStop()

Description copied from interface: Source

stop logging and get the output

init

public void init()

Called by SourceManager when it loads this source.

Specified by:

init in interface Source

Specified by:

init in class BaseSourceAdapter

toArray

public static <T> T[] toArray(Collection collection,
                              Class<T> theClass)

convert a list into an array of type of theClass

Type Parameters:

T - is the type of the array

Parameters:

collection - list to convert

theClass - type of array to return

Returns:

array of type theClass[] filled with the objects from list

getSubject

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

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

Overrides:

getSubject in class BaseSourceAdapter

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)

getSubject

@Deprecated
public Subject getSubject(String id)
                               throws SubjectNotFoundException,
                                      SubjectNotUniqueException

Deprecated.

Gets a Subject by its ID.

Specified by:

getSubject in interface Source

Specified by:

getSubject in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

Source.getSubject(java.lang.String)

getSubjectByIdentifier

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

note, you should implement this method since this implementation will become abstract at some point

Specified by:

getSubjectByIdentifier in interface Source

Overrides:

getSubjectByIdentifier in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

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

getSubjectByIdentifier

@Deprecated
public Subject getSubjectByIdentifier(String id)
                                           throws SubjectNotFoundException,
                                                  SubjectNotUniqueException

Deprecated.

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

Specified by:

getSubjectByIdentifier in interface Source

Specified by:

getSubjectByIdentifier in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

Source.getSubjectByIdentifier(java.lang.String)

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

Overrides:

searchPage in class BaseSourceAdapter

Returns:

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

See Also:

BaseSourceAdapter.searchPage(java.lang.String)

search

public Set<Subject> search(String searchValue)

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

Specified by:

search in class BaseSourceAdapter

Returns:

set

createSubject

public Subject createSubject(LdapEntry entry)

Parameters:

attributes -

getNeededProperty

protected String getNeededProperty(Properties props,
                                   String prop)

getAllAttributes

protected Map<String,Set<String>> getAllAttributes(SubjectImpl subject)

Try to get more attributes for the subject.

Parameters:

subject -

getLdapResults

protected Iterator<LdapEntry> getLdapResults(Search search,
                                             String searchValue,
                                             String[] attributeNames)

getLdapUnique

protected LdapEntry getLdapUnique(Search search,
                                  String searchValue,
                                  String[] attributeNames)
                           throws SubjectNotFoundException,
                                  SubjectNotUniqueException,
                                  SourceUnavailableException

Throws:

SubjectNotFoundException

SubjectNotUniqueException

SourceUnavailableException

escapeSearchFilter

protected String escapeSearchFilter(String filter)

Escape a search filter to prevent LDAP injection. From http://www.owasp.org/index.php/Preventing_LDAP_Injection_in_Java

Parameters:

filter -

Returns:

escaped filter

checkConfig

public void checkConfig()

Description copied from interface: Source

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

See Also:

Source.checkConfig()

printConfig

public String printConfig()

Description copied from interface: Source

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

Returns:

the info

See Also:

Source.printConfig()

setMultipleResults

public void setMultipleResults(boolean multipleResults)

Set whether or not multiple results are allowed. Primarily for tests.

Parameters:

multipleResults -

getMaxPage

public Integer getMaxPage()

max Page size

Returns:

the maxPage