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

Class ComputedIDDataConnector

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

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

Direct Known Subclasses:

StoredIDDataConnector

public class ComputedIDDataConnector
extends AbstractPersistentIdDataConnector

A data connector that delegates generation of IDs to a ComputedPersistentIdGenerationStrategy.

Field Summary

Fields

Modifier and Type	Field and Description
private ComputedPersistentIdGenerationStrategy	idStrategy Generation strategy for IDs.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
ComputedIDDataConnector() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	clearComputedIdStrategy() Clear the strategy plugin that generates computed IDs.
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()
ComputedPersistentIdGenerationStrategy	getComputedIdStrategy() Get the strategy plugin that generates computed IDs.
ComputedPersistentIdGenerationStrategy.Encoding	getEncoding() Get the post-digest encoding to use.
byte[]	getSalt() Get the salt used when computing the ID.
void	setAlgorithm(String alg) Set the JCE algorithm name of the digest algorithm to use (default is SHA).
void	setEncoding(ComputedPersistentIdGenerationStrategy.Encoding enc) Set the post-digest encoding to use.
void	setSalt(byte[] salt) Set the salt used when computing the ID.
void	setSalt(String salt) Set the salt used when computing the ID.

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.

idStrategy

@Nullable
private ComputedPersistentIdGenerationStrategy idStrategy

Generation strategy for IDs.

Constructor Detail

ComputedIDDataConnector

public ComputedIDDataConnector()

Constructor.

Method Detail

getComputedIdStrategy

@Nullable
public ComputedPersistentIdGenerationStrategy getComputedIdStrategy()

Get the strategy plugin that generates computed IDs.

Returns:

strategy for computing IDs

clearComputedIdStrategy

@Nullable
protected void clearComputedIdStrategy()

Clear the strategy plugin that generates computed IDs. This is needed to allow the StoredIDDataConnectorto work if no salt is configured.

getSalt

@Nullable
public byte[] getSalt()

Get the salt used when computing the ID.

Returns:

salt used when computing the ID

setSalt

public void setSalt(@Nullable
           byte[] salt)

Set the salt used when computing the ID.

Parameters:

salt - used when computing the ID

setSalt

public void setSalt(@Nullable
           String salt)

Set the salt used when computing the ID.

Parameters:

salt - used when computing the ID

getEncoding

@Nullable
public ComputedPersistentIdGenerationStrategy.Encoding getEncoding()

Get the post-digest encoding to use.

Returns:

post-digest encoding

setEncoding

public void setEncoding(@Nonnull
               ComputedPersistentIdGenerationStrategy.Encoding enc)

Set the post-digest encoding to use.

Parameters:

enc - encoding

setAlgorithm

public void setAlgorithm(@Nonnull@NotEmpty
                String alg)

Set the JCE algorithm name of the digest algorithm to use (default is SHA).

Parameters:

alg - JCE message digest algorithm

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractPersistentIdDataConnector

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class net.shibboleth.idp.attribute.resolver.AbstractResolverPlugin<Map<String,IdPAttribute>>

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

Specified by:

doDataConnectorResolve in class net.shibboleth.idp.attribute.resolver.AbstractDataConnector

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException