net.shibboleth.idp.attribute.resolver

Class AbstractDataConnector

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ResolvedDataConnector

@ThreadSafe
public abstract class AbstractDataConnector
extends AbstractResolverPlugin<Map<String,IdPAttribute>>
implements DataConnectorEx

Base class for data connector resolver plugins.

Field Summary

Fields

Modifier and Type	Field and Description
private String	failoverDataConnectorId ID of the data connector to use if this one fails.
private long	lastFail When did this connector last fail?
private org.slf4j.Logger	log Class logger.
private String	logPrefix cache for the log prefix - to save multiple recalculations.
private long	noRetryDelay How long to wait until we declare the connector live again.

Constructor Summary

Constructors

Constructor and Description
AbstractDataConnector()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Map<String,IdPAttribute>	doDataConnectorResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext) Retrieves a collection of attributes from some data source.
protected void	doInitialize()
Map<String,IdPAttribute>	doResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext) Perform the actual resolution.
String	getFailoverDataConnectorId() Gets the ID of the AbstractDataConnector whose values will be used in the event that this data connector experiences an error.
long	getLastFail() Get the time when this connector last failed.
protected String	getLogPrefix() Return a string which is to be prepended to all log messages.
long	getNoRetryDelay() Get how long to wait until we declare the connector (potentially) alive again.
void	setFailoverDataConnectorId(String id) Set the ID of the AbstractDataConnector whose values will be used in the event that this data connector experiences an error.
void	setLastFail(long time) Set the time when this connector last failed.
void	setNoRetryDelay(long delay) Set how long to wait until we declare the connector (potentially) alive again.

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

@Nonnull
private final org.slf4j.Logger log

Class logger.

failoverDataConnectorId

@Nullable
private String failoverDataConnectorId

ID of the data connector to use if this one fails.

logPrefix

@Nullable
private String logPrefix

cache for the log prefix - to save multiple recalculations.

lastFail

private long lastFail

When did this connector last fail?

noRetryDelay

@Duration
private long noRetryDelay

How long to wait until we declare the connector live again.

Constructor Detail

AbstractDataConnector

public AbstractDataConnector()

Method Detail

getFailoverDataConnectorId

@Nullable
public String getFailoverDataConnectorId()

Gets the ID of the AbstractDataConnector whose values will be used in the event that this data connector experiences an error.

Specified by:

getFailoverDataConnectorId in interface DataConnector

Returns:

ID of the AbstractDataConnector whose values will be used in the event that this data connector experiences an error

setFailoverDataConnectorId

public void setFailoverDataConnectorId(@Nullable
                              String id)

Set the ID of the AbstractDataConnector whose values will be used in the event that this data connector experiences an error.

Parameters:

id - ID of the AbstractDataConnector whose values will be used in the event that this data connector experiences an error

setLastFail

public void setLastFail(long time)

Set the time when this connector last failed.

Parameters:

time - what to set

getLastFail

public long getLastFail()

Get the time when this connector last failed. This will be set for any exception regardless of the setting of ResolverPlugin.isPropagateResolutionExceptions()

Specified by:

getLastFail in interface DataConnectorEx

Returns:

when it last failed

setNoRetryDelay

@Duration
public void setNoRetryDelay(@Duration
                            long delay)

Set how long to wait until we declare the connector (potentially) alive again.

Parameters:

delay - what to set

getNoRetryDelay

@Duration
public long getNoRetryDelay()

Get how long to wait until we declare the connector (potentially) alive again.

Specified by:

getNoRetryDelay in interface DataConnectorEx

Returns:

how long to wait.

doResolve

@Nullable
public final Map<String,IdPAttribute> doResolve(@Nonnull
                                          AttributeResolutionContext resolutionContext,
                                          @Nonnull
                                          AttributeResolverWorkContext workContext)
                                         throws ResolutionException

Perform the actual resolution. The resolved attribute(s) should not be recorded in the work context. This method delegates to doDataConnectorResolve(AttributeResolutionContext, AttributeResolverWorkContext). It serves as a future extension point for introducing new common behavior.

Specified by:

doResolve in class AbstractResolverPlugin<Map<String,IdPAttribute>>

Parameters:

resolutionContext - current resolution context

workContext - child context where intermediate results are tracked

Returns:

the resolved attributes or null if no attributes were resolved

Throws:

ResolutionException - thrown if there is a problem resolving the attributes

See Also:

AbstractResolverPlugin.resolve(AttributeResolutionContext)

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractResolverPlugin<Map<String,IdPAttribute>>

Throws:

ComponentInitializationException

doDataConnectorResolve

@Nullable
protected abstract Map<String,IdPAttribute> doDataConnectorResolve(@Nonnull
                                                       AttributeResolutionContext resolutionContext,
                                                       @Nonnull
                                                       AttributeResolverWorkContext workContext)
                                                            throws ResolutionException

Retrieves a collection of attributes from some data source.

Parameters:

resolutionContext - current resolution context

workContext - current resolver work context

Returns:

collected attributes indexed by attribute ID

Throws:

ResolutionException - thrown if there is a problem resolving the attributes

getLogPrefix

@Nonnull
@NotEmpty
protected String getLogPrefix()

Return a string which is to be prepended to all log messages.

Returns:

"Data connector '' :"