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

Class AbstractPersistentIdDataConnector

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

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:

ComputedIDDataConnector

public abstract class AbstractPersistentIdDataConnector
extends net.shibboleth.idp.attribute.resolver.AbstractDataConnector

The basis of a DataConnector that handles persistent IDs that depend on a source IdPAttribute.

Field Summary

Fields

Modifier and Type	Field and Description
private String	generatedAttribute ID of the attribute generated by this data connector.
private org.slf4j.Logger	log Class logger.
private String	sourceAttribute ID of the attribute whose first value is used when generating the computed ID.

Constructor Summary

Constructors

Constructor and Description
AbstractPersistentIdDataConnector()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected Map<String,IdPAttribute>	encodeAsAttribute(String value) Encode the provided string.
String	getGeneratedAttributeId() Get the ID of the attribute generated by this connector.
String	getSourceAttributeId() Get the ID of the attribute whose first value is used when generating the computed ID.
protected String	resolveSourceAttribute(net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext) Helper function to locate the source Attribute in the dependencies.
void	setGeneratedAttributeId(String newAttributeId) Set the ID of the attribute generated by this connector.
void	setSourceAttributeId(String newAttributeId) Set the ID of the attribute whose first value is used when generating the computed ID.

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

doDataConnectorResolve, 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

@Nonnull
private final org.slf4j.Logger log

Class logger.

generatedAttribute

@NonnullAfterInit
private String generatedAttribute

ID of the attribute generated by this data connector.

sourceAttribute

@NonnullAfterInit
private String sourceAttribute

ID of the attribute whose first value is used when generating the computed ID.

Constructor Detail

AbstractPersistentIdDataConnector

public AbstractPersistentIdDataConnector()

Method Detail

getSourceAttributeId

@NonnullAfterInit
public String getSourceAttributeId()

Get the ID of the attribute whose first value is used when generating the computed ID.

Returns:

ID of the attribute whose first value is used when generating the computed ID

setSourceAttributeId

public void setSourceAttributeId(@Nullable
                        String newAttributeId)

Set the ID of the attribute whose first value is used when generating the computed ID.

Parameters:

newAttributeId - what to set.

getGeneratedAttributeId

@NonnullAfterInit
public String getGeneratedAttributeId()

Get the ID of the attribute generated by this connector.

Returns:

ID of the attribute generated by this connector

setGeneratedAttributeId

public void setGeneratedAttributeId(@Nullable
                           String newAttributeId)

Set the ID of the attribute generated by this connector.

Parameters:

newAttributeId - what to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

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

Throws:

ComponentInitializationException

resolveSourceAttribute

@Nullable
protected String resolveSourceAttribute(@Nonnull
                                     net.shibboleth.idp.attribute.resolver.context.AttributeResolverWorkContext workContext)

Helper function to locate the source Attribute in the dependencies.

Parameters:

workContext - the context to look in

Returns:

the value, or null in any of the failure cases.

encodeAsAttribute

@Nullable
protected Map<String,IdPAttribute> encodeAsAttribute(@Nullable
                                                  String value)

Encode the provided string.

Parameters:

value - the value to encode or null if that failed

Returns:

null or the attribute.