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

Class RDBMSDataConnector

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

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

All Implemented Interfaces:

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

public class RDBMSDataConnector
extends AbstractSearchDataConnector<ExecutableStatement>

A DataConnector that queries a relation database in order to retrieve attribute data.

Field Summary

Fields

Modifier and Type	Field and Description
private DataSource	dataSource JDBC data source for retrieving Connections.
private boolean	defaultMappingStrategy Whether the default mapping strategy is being used.
private boolean	defaultValidator Whether the default validator is being used.
private org.slf4j.Logger	log Class logger.
private boolean	readOnlyConnection Whether the JDBC connection is read-only.

Constructor Summary

Constructors

Constructor and Description
RDBMSDataConnector() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
DataSource	getDataSource() Gets the JDBC data source for retrieving Connections.
boolean	isConnectionReadOnly() Gets whether this data connector uses read-only connections.
protected Map<String,IdPAttribute>	retrieveAttributes(ExecutableStatement statement) Attempts to retrieve the attribute from the database.
void	setConnectionReadOnly(boolean isReadOnly) Sets whether this data connector uses read-only connections.
void	setDataSource(DataSource source) Sets the JDBC data source for retrieving Connections.
void	setMappingStrategy(MappingStrategy strategy) Sets the strategy for mapping from search results to a collection of IdPAttributes.
void	setValidator(Validator validator) Sets the validator used to validate this connector.

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

doDataConnectorResolve, getExecutableSearchBuilder, getMappingStrategy, getResultsCache, getValidator, setExecutableSearchBuilder, setResultsCache

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

private final org.slf4j.Logger log

Class logger.

dataSource

private DataSource dataSource

JDBC data source for retrieving Connections.

readOnlyConnection

private boolean readOnlyConnection

Whether the JDBC connection is read-only.

defaultValidator

private boolean defaultValidator

Whether the default validator is being used.

defaultMappingStrategy

private boolean defaultMappingStrategy

Whether the default mapping strategy is being used.

Constructor Detail

RDBMSDataConnector

public RDBMSDataConnector()

Constructor.

Method Detail

getDataSource

public DataSource getDataSource()

Gets the JDBC data source for retrieving Connections.

Returns:

JDBC data source for retrieving Connections

setDataSource

public void setDataSource(@Nonnull
                 DataSource source)

Sets the JDBC data source for retrieving Connections.

Parameters:

source - JDBC data source for retrieving Connections

isConnectionReadOnly

public boolean isConnectionReadOnly()

Gets whether this data connector uses read-only connections.

Returns:

whether this data connector uses read-only connections

setConnectionReadOnly

public void setConnectionReadOnly(boolean isReadOnly)

Sets whether this data connector uses read-only connections.

Parameters:

isReadOnly - whether this data connector uses read-only connections

setValidator

public void setValidator(@Nonnull
                Validator validator)

Sets the validator used to validate this connector.

Overrides:

setValidator in class AbstractSearchDataConnector<ExecutableStatement>

Parameters:

validator - used to validate this connector

setMappingStrategy

public void setMappingStrategy(@Nonnull
                      MappingStrategy strategy)

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

Overrides:

setMappingStrategy in class AbstractSearchDataConnector<ExecutableStatement>

Parameters:

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

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractSearchDataConnector<ExecutableStatement>

Throws:

ComponentInitializationException

retrieveAttributes

@Nullable
protected Map<String,IdPAttribute> retrieveAttributes(ExecutableStatement statement)
                                               throws ResolutionException

Attempts to retrieve the attribute from the database.

Specified by:

retrieveAttributes in class AbstractSearchDataConnector<ExecutableStatement>

Parameters:

statement - statement used to retrieve data from the database

Returns:

attributes gotten from the database

Throws:

ResolutionException - thrown if there is a problem retrieving data from the database or transforming that data into IdPAttributes