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

Class TemplatedExecutableSearchFilterBuilder

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.TemplatedExecutableSearchFilterBuilder

All Implemented Interfaces:

ExecutableSearchBuilder<ExecutableSearchFilter>, Component, DestructableComponent, InitializableComponent

public class TemplatedExecutableSearchFilterBuilder
extends AbstractExecutableSearchFilterBuilder

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	TemplatedExecutableSearchFilterBuilder.EscapingReferenceInsertionEventHandler Escapes LDAP attribute values added to the template context.

Field Summary

Fields

Modifier and Type	Field and Description
private VelocityEngine	engine VelocityEngine.
private ReferenceInsertionEventHandler	eventHandler Event handler used for escaping.
private org.slf4j.Logger	log Class logger.
private Template	template Template evaluated to generate a search filter.
private String	templateText Template (as Text) to be evaluated.
private boolean	v2Compatibility Do we need to make ourself V2 Compatible?

Constructor Summary

Constructors

Constructor and Description
TemplatedExecutableSearchFilterBuilder()

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()
ReferenceInsertionEventHandler	getReferenceInsertionEventHandler() Gets the ReferenceInsertionEventHandler to be used.
Template	getTemplate() Gets the template to be evaluated.
String	getTemplateText() Gets the template text to be evaluated.
VelocityEngine	getVelocityEngine() Gets the VelocityEngine to be used.
boolean	isV2Compatibility() Are we in V2 Compatibility mode?
protected String	merge(VelocityContext context) Invokes Template.merge(org.apache.velocity.context.Context) on the supplied context.
void	setReferenceInsertionEventHandler(ReferenceInsertionEventHandler handler) Sets the ReferenceInsertionEventHandler to be used.
void	setTemplateText(String velocityTemplate) Sets the template to be evaluated.
void	setV2Compatibility(boolean compat) What is out V2 Compatibility mode.
void	setVelocityEngine(VelocityEngine velocityEngine) Sets the VelocityEngine to be used.

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

log

private final org.slf4j.Logger log

Class logger.

template

private Template template

Template evaluated to generate a search filter.

templateText

private String templateText

Template (as Text) to be evaluated.

engine

private VelocityEngine engine

VelocityEngine.

eventHandler

private ReferenceInsertionEventHandler eventHandler

Event handler used for escaping.

v2Compatibility

private boolean v2Compatibility

Do we need to make ourself V2 Compatible?

Constructor Detail

TemplatedExecutableSearchFilterBuilder

public TemplatedExecutableSearchFilterBuilder()

Method Detail

getTemplate

@NonnullAfterInit
public Template getTemplate()

Gets the template to be evaluated.

Returns:

the template

getTemplateText

@NonnullAfterInit
public String getTemplateText()

Gets the template text to be evaluated.

Returns:

the template text

setTemplateText

public void setTemplateText(@Nullable
                   String velocityTemplate)

Sets the template to be evaluated.

Parameters:

velocityTemplate - template to be evaluated

getVelocityEngine

@Nullable
@NonnullAfterInit
public VelocityEngine getVelocityEngine()

Gets the VelocityEngine to be used.

Returns:

the velocity engine

setVelocityEngine

public void setVelocityEngine(VelocityEngine velocityEngine)

Sets the VelocityEngine to be used.

Parameters:

velocityEngine - engine to be used

getReferenceInsertionEventHandler

@Nullable
public ReferenceInsertionEventHandler getReferenceInsertionEventHandler()

Gets the ReferenceInsertionEventHandler to be used.

Returns:

the reference insertion event handler

setReferenceInsertionEventHandler

public void setReferenceInsertionEventHandler(@Nullable
                                     ReferenceInsertionEventHandler handler)

Sets the ReferenceInsertionEventHandler to be used.

Parameters:

handler - reference insertion event handler to be used

isV2Compatibility

public boolean isV2Compatibility()

Are we in V2 Compatibility mode?

Returns:

Returns the v2Compat.

setV2Compatibility

public void setV2Compatibility(boolean compat)

What is out V2 Compatibility mode.

Parameters:

compat - The mode to set.

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

merge

protected String merge(@Nonnull
           VelocityContext context)

Invokes Template.merge(org.apache.velocity.context.Context) on the supplied context.

Parameters:

context - to merge

Returns:

result of the merge operation

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException