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

Class AbstractExecutableStatementBuilder

java.lang.Object

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

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

All Implemented Interfaces:

ExecutableSearchBuilder<ExecutableStatement>, Component, DestructableComponent, InitializableComponent

Direct Known Subclasses:

FormatExecutableStatementBuilder, TemplatedExecutableStatementBuilder

public abstract class AbstractExecutableStatementBuilder
extends AbstractInitializableComponent
implements ExecutableSearchBuilder<ExecutableStatement>

Basis of statement builder. The derived classes just have to provide the per request sql string.

Field Summary

Fields

Modifier and Type	Field and Description
private int	queryTimeout Query timeout.

Constructor Summary

Constructors

Constructor and Description
AbstractExecutableStatementBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ExecutableStatement	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.
int	getQueryTimeout() Gets the timeout of the SQL query.
protected abstract String	getSQLQuery(AttributeResolutionContext resolutionContext, Map<String,List<IdPAttributeValue<?>>> dependencyAttributes) Method to return the query SQL.
void	setQueryTimeout(int timeout) Sets the timeout of the SQL query.

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

destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Field Detail

queryTimeout

private int queryTimeout

Query timeout.

Constructor Detail

AbstractExecutableStatementBuilder

public AbstractExecutableStatementBuilder()

Method Detail

getQueryTimeout

public int getQueryTimeout()

Gets the timeout of the SQL query.

Returns:

timeout of the SQL query in seconds

setQueryTimeout

public void setQueryTimeout(int timeout)

Sets the timeout of the SQL query.

Parameters:

timeout - of the SQL query in seconds

getSQLQuery

protected abstract String getSQLQuery(@Nonnull
                 AttributeResolutionContext resolutionContext,
                 @Nonnull
                 Map<String,List<IdPAttributeValue<?>>> dependencyAttributes)
                               throws ResolutionException

Method to return the query SQL.

Parameters:

resolutionContext - the context of the resolution

dependencyAttributes - made available to the executable search

Returns:

the SQL string

Throws:

ResolutionException - if we get an error building the exception.

build

public ExecutableStatement 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.

Specified by:

build in interface ExecutableSearchBuilder<ExecutableStatement>

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