net.shibboleth.idp.saml.attribute.resolver.impl

Class StoredIDDataConnector

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.saml.attribute.resolver.impl.AbstractPersistentIdDataConnector

net.shibboleth.idp.saml.attribute.resolver.impl.ComputedIDDataConnector

net.shibboleth.idp.saml.attribute.resolver.impl.StoredIDDataConnector

All Implemented Interfaces:

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

public class StoredIDDataConnector
extends ComputedIDDataConnector

A data connector that delegates generation of IDs to a StoredPersistentIdGenerationStrategy that makes use of a JDBCPersistentIdStoreEx.

Field Summary

Fields

Modifier and Type	Field and Description
private JDBCPersistentIdStoreEx	idStore The JDBCPersistentIdStoreEx used to manage IDs.
private org.slf4j.Logger	log Class logger.
private StoredPersistentIdGenerationStrategy	storedIdStrategy Persistent ID generation mechanism.

Constructor Summary

Constructors

Constructor and Description
StoredIDDataConnector() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<String,IdPAttribute>	doDataConnectorResolve(net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext, net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext)
protected void	doDestroy()
protected void	doInitialize()
DataSource	getDataSource() Get the DataSource used to communicate with the database.
boolean	getFailFast() Get whether to allow startup if the database cannot be verified.
long	getQueryTimeout() Get the SQL query timeout.
Collection<String>	getRetryableErrors() Get the error messages to check for classifying a driver error as retryable, generally indicating a lock violation or duplicate insert that signifies a broken database.
JDBCPersistentIdStoreEx	getStoredIDStore() Get the data store used to manage stored IDs.
int	getTransactionRetries() Get the number of retries to attempt for a failed transaction.
void	setDataSource(DataSource source) Set the DataSource used to communicate with the database.
void	setFailFast(boolean flag) Set whether to allow startup if the database cannot be verified.
void	setQueryTimeout(long timeout) Set the SQL query timeout.
void	setRetryableErrors(Collection<String> errors) Set the error messages to check for classifying a driver error as retryable, generally indicating a lock violation or duplicate insert that signifies a broken database.
void	setTransactionRetries(int retries) Set the number of retries to attempt for a failed transaction.

Methods inherited from class net.shibboleth.idp.saml.attribute.resolver.impl.ComputedIDDataConnector

clearComputedIdStrategy, getComputedIdStrategy, getEncoding, getSalt, setAlgorithm, setEncoding, setSalt, setSalt

Methods inherited from class net.shibboleth.idp.saml.attribute.resolver.impl.AbstractPersistentIdDataConnector

encodeAsAttribute, getGeneratedAttributeId, getSourceAttributeId, resolveSourceAttribute, setGeneratedAttributeId, setSourceAttributeId

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

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

@Nonnull
private final org.slf4j.Logger log

Class logger.

idStore

@Nonnull
private final JDBCPersistentIdStoreEx idStore

The JDBCPersistentIdStoreEx used to manage IDs.

storedIdStrategy

@Nonnull
private final StoredPersistentIdGenerationStrategy storedIdStrategy

Persistent ID generation mechanism.

Constructor Detail

StoredIDDataConnector

public StoredIDDataConnector()

Constructor.

Method Detail

getDataSource

@NonnullAfterInit
public DataSource getDataSource()

Get the DataSource used to communicate with the database.

Returns:

the DataSource

setDataSource

public void setDataSource(@Nonnull
                 DataSource source)

Set the DataSource used to communicate with the database.

Parameters:

source - the DataSource.

getStoredIDStore

@Nonnull
public JDBCPersistentIdStoreEx getStoredIDStore()

Get the data store used to manage stored IDs.

Returns:

data store used to manage stored IDs

getRetryableErrors

@Nonnull
@NonnullElements
public Collection<String> getRetryableErrors()

Get the error messages to check for classifying a driver error as retryable, generally indicating a lock violation or duplicate insert that signifies a broken database.

Returns:

retryable messages

setRetryableErrors

public void setRetryableErrors(@Nullable@NonnullElements
                      Collection<String> errors)

Set the error messages to check for classifying a driver error as retryable, generally indicating a lock violation or duplicate insert that signifies a broken database.

Parameters:

errors - retryable messages

getQueryTimeout

@Duration
@NonNegative
public long getQueryTimeout()

Get the SQL query timeout.

Returns:

the timeout in milliseconds

setQueryTimeout

@Duration
public void setQueryTimeout(@Duration@NonNegative
                            long timeout)

Set the SQL query timeout.

Parameters:

timeout - the timeout to set in seconds

getTransactionRetries

public int getTransactionRetries()

Get the number of retries to attempt for a failed transaction.

Returns:

number of retries

setTransactionRetries

public void setTransactionRetries(@NonNegative
                         int retries)

Set the number of retries to attempt for a failed transaction. Defaults to 3.

Parameters:

retries - the number of retries

getFailFast

public boolean getFailFast()

Get whether to allow startup if the database cannot be verified.

Returns:

whether to allow startup if the database cannot be verified

setFailFast

public void setFailFast(boolean flag)

Set whether to allow startup if the database cannot be verified.

Verification consists not only of a liveness check, but the successful insertion of a dummy row, a failure to insert a duplicate, and then deletion of the row.

Parameters:

flag - flag to set

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class ComputedIDDataConnector

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class ComputedIDDataConnector

doDataConnectorResolve

@Nullable
protected Map<String,IdPAttribute> doDataConnectorResolve(@Nonnull
                                                       net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext,
                                                       @Nonnull
                                                       net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext)
                                                   throws net.shibboleth.idp.attribute.resolver.ResolutionException

Overrides:

doDataConnectorResolve in class ComputedIDDataConnector

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException