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

Class TransientIdAttributeDefinition

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

net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

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

All Implemented Interfaces:

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

public class TransientIdAttributeDefinition
extends net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

An attribute definition that generates random identifiers useful for transient subject IDs.

The generation in devolved to the supplied TransientIdGenerationStrategy, which will be a StoredTransientIdGenerationStrategy for the Transient and CryptoTransientIdGenerationStrategy for a CryptoTransient.

Field Summary

Fields

Modifier and Type	Field and Description
private TransientIdGenerationStrategy	idGenerator The actual implementation of the transient generation process.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
TransientIdAttributeDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
protected IdPAttribute	doAttributeDefinitionResolve(net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext, net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext)
protected void	doInitialize()
private String	getAttributeRecipientID(net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext) Police and get the AttributeRecipientID.
private String	getPrincipal(net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext context) Police and get the Principal.
TransientIdGenerationStrategy	getTransientIdGenerationStrategy() return the id generator being used.
void	setTransientIdGenerationStrategy(TransientIdGenerationStrategy generator) Set the id generator being used.

Methods inherited from class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

doResolve, getAttributeEncoders, getDisplayDescriptions, getDisplayNames, getLogPrefix, getSourceAttributeId, isDependencyOnly, setAttributeEncoders, setDependencyOnly, setDisplayDescriptions, setDisplayNames, setSourceAttributeId

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.

idGenerator

@Nonnull
private TransientIdGenerationStrategy idGenerator

The actual implementation of the transient generation process.

Constructor Detail

TransientIdAttributeDefinition

public TransientIdAttributeDefinition()

Method Detail

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

Throws:

ComponentInitializationException

setTransientIdGenerationStrategy

@Nonnull
public void setTransientIdGenerationStrategy(@Nonnull
                                            TransientIdGenerationStrategy generator)

Set the id generator being used.

Parameters:

generator - the (crypto or transient) generator to use

getTransientIdGenerationStrategy

@Nonnull
public TransientIdGenerationStrategy getTransientIdGenerationStrategy()

return the id generator being used. This is primarily used in testing.

Returns:

the generator strategy;

doAttributeDefinitionResolve

@Nonnull
protected IdPAttribute doAttributeDefinitionResolve(@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:

doAttributeDefinitionResolve in class net.shibboleth.idp.attribute.resolver.AbstractAttributeDefinition

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException

getAttributeRecipientID

@Nonnull
@NotEmpty
private String getAttributeRecipientID(@Nonnull
                                              net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext resolutionContext)
                                throws net.shibboleth.idp.attribute.resolver.ResolutionException

Police and get the AttributeRecipientID.

Parameters:

resolutionContext - where to look

Returns:

the AttributeRecipientID

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if it was non null

getPrincipal

@Nonnull
@NotEmpty
private String getPrincipal(@Nonnull
                                   net.shibboleth.idp.attribute.resolver.context.AttributeResolutionContext context)
                     throws net.shibboleth.idp.attribute.resolver.ResolutionException

Police and get the Principal.

Parameters:

context - where to look

Returns:

the Principal

Throws:

net.shibboleth.idp.attribute.resolver.ResolutionException - if it was non null