Package net.shibboleth.idp.attribute.resolver.dc.ldap.impl

Class LDAPDataConnector

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin<Map<String,IdPAttribute>>

net.shibboleth.idp.attribute.resolver.AbstractDataConnector

net.shibboleth.idp.attribute.resolver.dc.impl.AbstractSearchDataConnector<ExecutableSearchFilter,SearchResultMappingStrategy>

net.shibboleth.idp.attribute.resolver.dc.ldap.impl.LDAPDataConnector

All Implemented Interfaces:

DataConnector, ResolverPlugin<Map<String,IdPAttribute>>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, DisposableBean

public class LDAPDataConnector
extends AbstractSearchDataConnector<ExecutableSearchFilter,SearchResultMappingStrategy>

A DataConnector that queries an LDAP in order to retrieve attribute data.

Field Summary

Fields

Modifier and Type	Field	Description
private ConnectionFactory	connectionFactory	Factory for retrieving LDAP connections.
private boolean	defaultMappingStrategy	Whether the default mapping strategy is being used.
private boolean	defaultValidator	Whether the default validator is being used.
private final org.slf4j.Logger	log	Class logger.
private SearchExecutor	searchExecutor	For executing LDAP searches.

Constructor Summary

Constructors

Constructor	Description
LDAPDataConnector()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doDestroy()
protected void	doInitialize()
ConnectionFactory	getConnectionFactory()	Gets the connection factory for retrieving Connections.
SearchExecutor	getSearchExecutor()	Gets the search executor for executing searches.
private void	policeForJVMTrust()	Police TLS for JVM trust.
protected Map<String,IdPAttribute>	retrieveAttributes(ExecutableSearchFilter filter)	Attempts to retrieve attributes from the LDAP.
void	setConnectionFactory(ConnectionFactory factory)	Sets the connection factory for retrieving Connections.
void	setMappingStrategy(SearchResultMappingStrategy strategy)	Sets the strategy for mapping from search results to a collection of IdPAttributes.
void	setSearchExecutor(SearchExecutor executor)	Sets the search executor for executing searches.
void	setValidator(Validator validator)	Sets the validator used to validate this connector.

Methods inherited from class net.shibboleth.idp.attribute.resolver.dc.impl.AbstractSearchDataConnector

doDataConnectorResolve, getExecutableSearchBuilder, getMappingStrategy, getResultsCache, getValidator, isFailFastInitialize, setExecutableSearchBuilder, setFailFastInitialize, setResultsCache

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractDataConnector

doResolve, getExportAttributes, getFailoverDataConnectorId, getLastFail, getLastSuccess, getLogPrefix, getNoRetryDelay, isExportAllAttributes, setExportAllAttributes, setExportAttributes, setFailoverDataConnectorId, setLastFail, setLastSuccess, setNoRetryDelay

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin

addDisplayInformation, equals, getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, isSuppressDisplayInformation, resolve, setActivationCondition, setAttributeDependencies, setDataConnectorDependencies, setProfileContextStrategy, setPropagateResolutionExceptions, setSuppressDisplayInformation

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.idp.attribute.resolver.ResolverPlugin

getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, isPropagateResolutionExceptions, resolve

Field Details

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

connectionFactory

private ConnectionFactory connectionFactory

Factory for retrieving LDAP connections.

searchExecutor

private SearchExecutor searchExecutor

For executing LDAP searches.

defaultValidator

private boolean defaultValidator

Whether the default validator is being used.

defaultMappingStrategy

private boolean defaultMappingStrategy

Whether the default mapping strategy is being used.

Constructor Details

LDAPDataConnector

public LDAPDataConnector()

Constructor.

Method Details

getConnectionFactory

public ConnectionFactory getConnectionFactory()

Gets the connection factory for retrieving Connections.

Returns:

connection factory for retrieving Connections

setConnectionFactory

public void setConnectionFactory(@Nonnull
 ConnectionFactory factory)

Sets the connection factory for retrieving Connections.

Parameters:

factory - connection factory for retrieving Connections

getSearchExecutor

public SearchExecutor getSearchExecutor()

Gets the search executor for executing searches.

Returns:

search executor for executing searches

setSearchExecutor

public void setSearchExecutor(@Nonnull
 SearchExecutor executor)

Sets the search executor for executing searches.

Parameters:

executor - search executor for executing searches

setValidator

public void setValidator(@Nonnull
 Validator validator)

Sets the validator used to validate this connector.

Overrides:

setValidator in class AbstractSearchDataConnector<ExecutableSearchFilter,SearchResultMappingStrategy>

Parameters:

validator - used to validate this connector

setMappingStrategy

public void setMappingStrategy(@Nonnull
 SearchResultMappingStrategy strategy)

Sets the strategy for mapping from search results to a collection of IdPAttributes.

Overrides:

setMappingStrategy in class AbstractSearchDataConnector<ExecutableSearchFilter,SearchResultMappingStrategy>

Parameters:

strategy - strategy for mapping from search results to a collection of IdPAttributes

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractSearchDataConnector<ExecutableSearchFilter,SearchResultMappingStrategy>

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractResolverPlugin<Map<String,IdPAttribute>>

policeForJVMTrust

private void policeForJVMTrust()
                        throws ComponentInitializationException

Police TLS for JVM trust.

Throws:

ComponentInitializationException - if we detect an SSL issue

retrieveAttributes

@Nullable
protected Map<String,IdPAttribute> retrieveAttributes(ExecutableSearchFilter filter)
                                               throws ResolutionException

Attempts to retrieve attributes from the LDAP.

Specified by:

retrieveAttributes in class AbstractSearchDataConnector<ExecutableSearchFilter,SearchResultMappingStrategy>

Parameters:

filter - search filter used to retrieve data from the LDAP

Returns:

search result from the LDAP

Throws:

ResolutionException - thrown if there is a problem retrieving data from the LDAP