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

Class AbstractSearchDataConnector<T extends ExecutableSearch>

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<T>

Type Parameters:

T - type of executable search

All Implemented Interfaces:

DataConnector, DataConnectorEx, ResolverPlugin<Map<String,IdPAttribute>>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, org.springframework.beans.factory.DisposableBean

Direct Known Subclasses:

LDAPDataConnector, RDBMSDataConnector

public abstract class AbstractSearchDataConnector<T extends ExecutableSearch>
extends AbstractDataConnector

A DataConnector containing functionality common to data connectors that retrieve attribute data by searching a data source.

Field Summary

Fields

Modifier and Type	Field and Description
private Validator	connectorValidator Validator for validating this data connector.
private org.slf4j.Logger	log Class logger.
private MappingStrategy	mappingStrategy Strategy for mapping search results to a collection of IdPAttributes.
private Cache<String,Map<String,IdPAttribute>>	resultsCache Query result cache.
private ExecutableSearchBuilder<T>	searchBuilder Builder used to create executable searches.

Constructor Summary

Constructors

Constructor and Description
AbstractSearchDataConnector()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,IdPAttribute>	doDataConnectorResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext)
protected void	doInitialize()
ExecutableSearchBuilder<T>	getExecutableSearchBuilder() Gets the builder used to create executable searches.
MappingStrategy	getMappingStrategy() Gets the strategy for mapping from search results to a collection of IdPAttributes.
Cache<String,Map<String,IdPAttribute>>	getResultsCache() Gets the cache used to cache search results.
Validator	getValidator() Gets the validator used to validate this connector.
protected abstract Map<String,IdPAttribute>	retrieveAttributes(T executable) Attempts to retrieve attributes from the data source.
void	setExecutableSearchBuilder(ExecutableSearchBuilder<T> builder) Sets the builder used to create the executable searches.
void	setMappingStrategy(MappingStrategy strategy) Sets the strategy for mapping from search results to a collection of IdPAttributes.
void	setResultsCache(Cache<String,Map<String,IdPAttribute>> cache) Sets the cache used to cache search results.
void	setValidator(Validator validator) Sets the validator used to validate this connector.

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

doResolve, getFailoverDataConnectorId, getLastFail, getLogPrefix, getNoRetryDelay, setFailoverDataConnectorId, setLastFail, setNoRetryDelay

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

doDestroy, equals, getActivationCondition, getDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, resolve, setActivationCondition, setDependencies, setProfileContextStrategy, setPropagateResolutionExceptions

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.idp.attribute.resolver.ResolverPlugin

getActivationCondition, getDependencies, isPropagateResolutionExceptions, resolve

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

initialize, isInitialized

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

destroy, isDestroyed

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

getId

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

destroy

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

searchBuilder

private ExecutableSearchBuilder<T extends ExecutableSearch> searchBuilder

Builder used to create executable searches.

connectorValidator

private Validator connectorValidator

Validator for validating this data connector.

mappingStrategy

private MappingStrategy mappingStrategy

Strategy for mapping search results to a collection of IdPAttributes.

resultsCache

private Cache<String,Map<String,IdPAttribute>> resultsCache

Query result cache.

Constructor Detail

AbstractSearchDataConnector

public AbstractSearchDataConnector()

Method Detail

getExecutableSearchBuilder

public ExecutableSearchBuilder<T> getExecutableSearchBuilder()

Gets the builder used to create executable searches.

Returns:

builder used to create the executable searches

setExecutableSearchBuilder

public void setExecutableSearchBuilder(@Nonnull
                              ExecutableSearchBuilder<T> builder)

Sets the builder used to create the executable searches.

Parameters:

builder - builder used to create the executable searches

getValidator

public Validator getValidator()

Gets the validator used to validate this connector.

Returns:

validator used to validate this connector

setValidator

public void setValidator(@Nonnull
                Validator validator)

Sets the validator used to validate this connector.

Parameters:

validator - used to validate this connector

getMappingStrategy

public MappingStrategy getMappingStrategy()

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

Returns:

strategy for mapping from search results to a collection of IdPAttributes

setMappingStrategy

public void setMappingStrategy(@Nonnull
                      MappingStrategy strategy)

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

Parameters:

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

getResultsCache

@Nonnull
public Cache<String,Map<String,IdPAttribute>> getResultsCache()

Gets the cache used to cache search results.

Returns:

cache used to cache search results

setResultsCache

public void setResultsCache(@Nullable
                   Cache<String,Map<String,IdPAttribute>> cache)

Sets the cache used to cache search results. Note, all entries in the cache are invalidated prior to use.

Parameters:

cache - cache used to cache search results

retrieveAttributes

@Nullable
protected abstract Map<String,IdPAttribute> retrieveAttributes(@Nonnull
                                                   T executable)
                                                        throws ResolutionException

Attempts to retrieve attributes from the data source.

Parameters:

executable - used to retrieve data from the data source

Returns:

attributes

Throws:

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

doDataConnectorResolve

@Nullable
protected Map<String,IdPAttribute> doDataConnectorResolve(@Nonnull
                                                       AttributeResolutionContext resolutionContext,
                                                       @Nonnull
                                                       AttributeResolverWorkContext workContext)
                                                   throws ResolutionException

Specified by:

doDataConnectorResolve in class AbstractDataConnector

Throws:

ResolutionException

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractDataConnector

Throws:

ComponentInitializationException