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

Class ParameterizedExecutableSearchFilterBuilder

java.lang.Object

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

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

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

All Implemented Interfaces:

ExecutableSearchBuilder<ExecutableSearchFilter>, Component, DestructableComponent, InitializableComponent

public class ParameterizedExecutableSearchFilterBuilder
extends AbstractExecutableSearchFilterBuilder

An ExecutableSearchBuilder that generates the search filter to be executed by evaluating a parameterized filter string against the currently resolved attributes within a AttributeResolutionContext.

Field Summary

Fields

Modifier and Type	Field and Description
private String	searchFilter LDAP search filter.

Constructor Summary

Constructors

Constructor and Description
ParameterizedExecutableSearchFilterBuilder() Constructor.
ParameterizedExecutableSearchFilterBuilder(String filter) Deprecated. - use the proerty setters

Method Summary

Methods

Modifier and Type	Method and Description
ExecutableSearchFilter	build(AttributeResolutionContext resolutionContext, Map<String,List<IdPAttributeValue<?>>> dependencyAttributes) Creates an executable search that can be executed against a data source in order to produce results.
protected void	doInitialize()
void	setSearchFilter(String filter) Set the filter used for the LDAP search.

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

build

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

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

searchFilter

@NonnullAfterInit
private String searchFilter

LDAP search filter.

Constructor Detail

ParameterizedExecutableSearchFilterBuilder

@Deprecated
public ParameterizedExecutableSearchFilterBuilder(@Nonnull
                                                     String filter)

Deprecated. - use the proerty setters

Constructor.

Parameters:

filter - used for the LDAP search

ParameterizedExecutableSearchFilterBuilder

public ParameterizedExecutableSearchFilterBuilder()

Constructor.

Method Detail

setSearchFilter

public void setSearchFilter(@Nonnull
                   String filter)

Set the filter used for the LDAP search.

Parameters:

filter - used for the LDAP search

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

build

public ExecutableSearchFilter build(@Nonnull
                           AttributeResolutionContext resolutionContext,
                           @Nonnull
                           Map<String,List<IdPAttributeValue<?>>> dependencyAttributes)
                             throws ResolutionException

Creates an executable search that can be executed against a data source in order to produce results.

Parameters:

resolutionContext - current request context

dependencyAttributes - made available to the executable search

Returns:

executable search

Throws:

ResolutionException - throw if their is a problem creating the executable search