edu.internet2.middleware.subject.provider

Class JNDISourceAdapterLegacy

java.lang.Object

edu.internet2.middleware.subject.provider.BaseSourceAdapter

edu.internet2.middleware.subject.provider.JNDISourceAdapterLegacy

All Implemented Interfaces:

Source

public class JNDISourceAdapterLegacy
extends BaseSourceAdapter

JNDI Source

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	failOnSearchForTesting for testing if we should fail on testing
protected Integer	maxResults if there is a limit to the number of results
protected static HashMap<String,Integer>	scopeStrings Return scope for searching as a int - associate the string with the int

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

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

Constructor Summary

Constructors

Constructor and Description
JNDISourceAdapterLegacy() Allocates new JNDISourceAdapter;
JNDISourceAdapterLegacy(String id1, String name1) Allocates new JNDISourceAdapter;

Method Summary

Modifier and Type	Method and Description
void	checkConfig() make sure the config is ok, and log descriptive errors if not
protected String	escapeSearchFilter(String filter) Escape a search filter to prevent LDAP injection.
protected NamingEnumeration	getLdapResults(Search search, String searchValue, String[] attributeNames)
protected NamingEnumeration	getLdapResults(Search search, String searchValue, String[] attributeNames, boolean firstPageOnly)
protected Attributes	getLdapUnique(Search search, String searchValue, String[] attributeNames)
Integer	getMaxPage() max Page size
protected static int	getScope(String scope)
Subject	getSubject(String id1) Deprecated.
Subject	getSubject(String id1, boolean exceptionIfNull) Gets a Subject by its ID.
Subject	getSubjectByIdentifier(String id1) Deprecated.
Subject	getSubjectByIdentifier(String id1, 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.
protected Map	loadAttributes(SubjectImpl subject) Loads attributes for the argument subject.
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.
protected void	setupEnvironment(Properties props) Setup environment.

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

maxResults

protected Integer maxResults

if there is a limit to the number of results

scopeStrings

protected static HashMap<String,Integer> scopeStrings

Return scope for searching as a int - associate the string with the int

failOnSearchForTesting

public static boolean failOnSearchForTesting

for testing if we should fail on testing

Constructor Detail

JNDISourceAdapterLegacy

public JNDISourceAdapterLegacy()

Allocates new JNDISourceAdapter;

JNDISourceAdapterLegacy

public JNDISourceAdapterLegacy(String id1,
                               String name1)

Allocates new JNDISourceAdapter;

Parameters:

id1 -

name1 -

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

getScope

protected static int getScope(String scope)

Parameters:

scope -

Returns:

scope

getSubject

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

Description copied from interface: Source

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:

BaseSourceAdapter.getSubject(java.lang.String, boolean)

getSubjectByIdentifier

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

Description copied from class: BaseSourceAdapter

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:

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

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

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)

init

public void init()
          throws SourceUnavailableException

Description copied from class: BaseSourceAdapter

Called by SourceManager when it loads this source.

Specified by:

init in interface Source

Specified by:

init in class BaseSourceAdapter

Throws:

SourceUnavailableException

See Also:

BaseSourceAdapter.init()

setupEnvironment

protected void setupEnvironment(Properties props)
                         throws SourceUnavailableException

Setup environment.

Parameters:

props -

Throws:

SourceUnavailableException

loadAttributes

protected Map loadAttributes(SubjectImpl subject)

Loads attributes for the argument subject.

Parameters:

subject -

Returns:

the map

getLdapResults

protected NamingEnumeration getLdapResults(Search search,
                                           String searchValue,
                                           String[] attributeNames)

Parameters:

search -

searchValue -

attributeNames -

Returns:

naming enumeration

getLdapResults

protected NamingEnumeration getLdapResults(Search search,
                                           String searchValue,
                                           String[] attributeNames,
                                           boolean firstPageOnly)

Parameters:

search -

searchValue -

attributeNames -

Returns:

naming enumeration

getLdapUnique

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

Parameters:

search -

searchValue -

attributeNames -

Returns:

attributes

Throws:

SubjectNotFoundException

SubjectNotUniqueException

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()

getSubject

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

Deprecated.

Description copied from interface: Source

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:

BaseSourceAdapter.getSubject(java.lang.String)

getSubjectByIdentifier

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

Deprecated.

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

Specified by:

getSubjectByIdentifier in class BaseSourceAdapter

Returns:

subject

Throws:

SubjectNotFoundException

SubjectNotUniqueException

See Also:

BaseSourceAdapter.getSubjectByIdentifier(java.lang.String)

getMaxPage

public Integer getMaxPage()

max Page size

Returns:

the maxPage