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

Class FormatExecutableStatementBuilder

java.lang.Object

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

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

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

All Implemented Interfaces:

ExecutableSearchBuilder<ExecutableStatement>, Component, DestructableComponent, InitializableComponent

public class FormatExecutableStatementBuilder
extends AbstractExecutableStatementBuilder

An ExecutableSearchBuilder. It generates the SQL statement to be executed by invoking String.format(String, Object...) with AttributeResolutionContext.getPrincipal().

Field Summary

Fields

Modifier and Type	Field and Description
private String	sqlQuery SQL query string.

Constructor Summary

Constructors

Constructor and Description
FormatExecutableStatementBuilder() Constructor.
FormatExecutableStatementBuilder(String query) Deprecated. - use the property setters
FormatExecutableStatementBuilder(String query, int timeout) Deprecated. - use the property setters

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected String	getSQLQuery(AttributeResolutionContext resolutionContext, Map<String,List<IdPAttributeValue<?>>> dependencyAttributes) Method to return the query SQL.
void	setQuery(String query) Set the query to search the database.
void	setTimeOut(int timeout) Set the search timeout.

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

build, getQueryTimeout, setQueryTimeout

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

sqlQuery

private String sqlQuery

SQL query string.

Constructor Detail

FormatExecutableStatementBuilder

@Deprecated
public FormatExecutableStatementBuilder(@Nonnull
                                           String query)

Deprecated. - use the property setters

Constructor.

Parameters:

query - to search the database

FormatExecutableStatementBuilder

@Deprecated
public FormatExecutableStatementBuilder(@Nonnull
                                           String query,
                                           @Nonnull
                                           int timeout)

Deprecated. - use the property setters

Constructor.

Parameters:

query - to search the database

timeout - search timeout

FormatExecutableStatementBuilder

public FormatExecutableStatementBuilder()

Constructor.

Method Detail

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

setQuery

public void setQuery(@Nonnull
            String query)

Set the query to search the database.

Parameters:

query - query to search the database

setTimeOut

public void setTimeOut(@Nonnull
              int timeout)

Set the search timeout.

Parameters:

timeout - search timeout

getSQLQuery

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

Method to return the query SQL.

Specified by:

getSQLQuery in class AbstractExecutableStatementBuilder

Parameters:

resolutionContext - the context of the resolution

dependencyAttributes - made available to the executable search

Returns:

the SQL string