Package net.shibboleth.idp.attribute.resolver.ad.impl

Class StaticAttributeDefinition

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.attribute.resolver.ad.impl.StaticAttributeDefinition

All Implemented Interfaces:

AttributeDefinition, ResolverPlugin<IdPAttribute>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, DisposableBean

@ThreadSafe
public class StaticAttributeDefinition
extends AbstractAttributeDefinition

An attribute definition that simply returns a static value.

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private IdPAttribute	value	Static value returned by this definition.

Constructor Summary

Constructors

Constructor	Description
StaticAttributeDefinition()

Method Summary

Modifier and Type	Method	Description
protected IdPAttribute	doAttributeDefinitionResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext)	Creates and populates the values for the resolved attribute.
protected void	doInitialize()
IdPAttribute	getValue()	Return the static attribute we are returning.
void	setValue(IdPAttribute newAttribute)	Set the attribute value we are returning.

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

doResolve, getLogPrefix, isDependencyOnly, isPreRequested, setDependencyOnly, setPreRequested

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

addDisplayInformation, doDestroy, equals, getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, getProfileContextStrategy, hashCode, isPropagateResolutionExceptions, isSuppressDisplayInformation, resolve, setActivationCondition, setAttributeDependencies, setDataConnectorDependencies, setProfileContextStrategy, setPropagateResolutionExceptions, setSuppressDisplayInformation

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.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface org.springframework.beans.factory.DisposableBean

destroy

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.idp.attribute.resolver.ResolverPlugin

getActivationCondition, getAttributeDependencies, getDataConnectorDependencies, isPropagateResolutionExceptions, resolve

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

value

@NonnullAfterInit
private IdPAttribute value

Static value returned by this definition.

Constructor Detail

StaticAttributeDefinition

public StaticAttributeDefinition()

Method Detail

setValue

public void setValue(@Nullable
                     IdPAttribute newAttribute)

Set the attribute value we are returning.

Parameters:

newAttribute - what to set.

getValue

@NonnullAfterInit
public IdPAttribute getValue()

Return the static attribute we are returning.

Returns:

the attribute.

doAttributeDefinitionResolve

@Nonnull
protected IdPAttribute doAttributeDefinitionResolve(AttributeResolutionContext resolutionContext,
                                                    @Nonnull
                                                    AttributeResolverWorkContext workContext)
                                             throws ResolutionException

Creates and populates the values for the resolved attribute. Implementations should not set, or otherwise manage, the resolved attribute's display name, description or encoders. Nor should the resultant attribute be recorded in the given resolution context.

Specified by:

doAttributeDefinitionResolve in class AbstractAttributeDefinition

Parameters:

resolutionContext - current attribute resolution context

workContext - current resolver work context

Returns:

resolved attribute or null if nothing to resolve.

Throws:

ResolutionException - thrown if there is a problem resolving and creating the attribute

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractAttributeDefinition

Throws:

ComponentInitializationException