net.shibboleth.idp.attribute.resolver

Class ResolvedAttributeDefinition

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.ResolvedAttributeDefinition

All Implemented Interfaces:

AttributeDefinition, ResolverPlugin<IdPAttribute>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, org.springframework.beans.factory.DisposableBean

@ThreadSafe
public final class ResolvedAttributeDefinition
extends AbstractAttributeDefinition

A proxy which wraps a resolved attribute definition and always returns the same attribute. The goal being that once an attribute definition is resolved once this can be used in its place and calls to ResolverPlugin.resolve(AttributeResolutionContext) are "free". This proxy is immutable so all setter methods simply return.

Field Summary

Fields

Modifier and Type	Field and Description
private IdPAttribute	resolvedAttribute The attribute produced by the resolved attribute definition.
private AttributeDefinition	resolvedDefinition The attribute definition that was resolved to produce the attribute.

Constructor Summary

Constructors

Constructor and Description
ResolvedAttributeDefinition(AttributeDefinition definition, IdPAttribute attribute) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected IdPAttribute	doAttributeDefinitionResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext) Creates and populates the values for the resolved attribute.
boolean	equals(Object obj)
com.google.common.base.Predicate<ProfileRequestContext>	getActivationCondition() Get the predicate which defines whether this plugin is active for a given request.
Set<AttributeEncoder<?>>	getAttributeEncoders() Gets the unmodifiable encoders used to encode the values of this attribute in to protocol specific formats.
Set<ResolverPluginDependency>	getDependencies() Gets the unmodifiable list of dependencies for this plugin.
Map<Locale,String>	getDisplayDescriptions() Gets the localized human readable descriptions of attribute.
Map<Locale,String>	getDisplayNames() Gets the localized human readable names of the attribute.
String	getId()
IdPAttribute	getResolvedAttribute() Gets the resolved attribute.
AttributeDefinition	getResolvedDefinition() Gets the wrapped attribute definition that was resolved.
int	hashCode()
boolean	isDependencyOnly() Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.
boolean	isInitialized()
boolean	isPropagateResolutionExceptions() Get whether a ResolutionException that occurred resolving attributes will be re-thrown.
void	setDependencyOnly(boolean isDependencyOnly) Sets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.
void	setDisplayDescriptions(Map<Locale,String> descriptions) Sets the localized human readable descriptions of attribute.
void	setDisplayNames(Map<Locale,String> names) Sets the localized human readable names of the attribute.
void	setPropagateResolutionExceptions(boolean propagate) Set whether an AttributeResolutionContext that occurred resolving attributes will be re-thrown.
String	toString()

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

doInitialize, doResolve, getLogPrefix, getSourceAttributeId, setAttributeEncoders, setSourceAttributeId

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

doDestroy, getProfileContextStrategy, resolve, setActivationCondition, setDependencies, setProfileContextStrategy

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

resolve

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

initialize

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

destroy, isDestroyed

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

destroy

Field Detail

resolvedDefinition

@Nonnull
private final AttributeDefinition resolvedDefinition

The attribute definition that was resolved to produce the attribute.

resolvedAttribute

@Nullable
private final IdPAttribute resolvedAttribute

The attribute produced by the resolved attribute definition.

Constructor Detail

ResolvedAttributeDefinition

public ResolvedAttributeDefinition(@Nonnull
                           AttributeDefinition definition,
                           @Nullable
                           IdPAttribute attribute)

Constructor.

Parameters:

definition - attribute definition that was resolved to produce the given attribute

attribute - attribute produced by the given attribute definition

Method Detail

doAttributeDefinitionResolve

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

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractResolverPlugin<IdPAttribute>

getAttributeEncoders

@Nonnull
@NonnullElements
public Set<AttributeEncoder<?>> getAttributeEncoders()

Gets the unmodifiable encoders used to encode the values of this attribute in to protocol specific formats. The returned collection is never null nor contains any null.

Specified by:

getAttributeEncoders in interface AttributeDefinition

Overrides:

getAttributeEncoders in class AbstractAttributeDefinition

Returns:

encoders used to encode the values of this attribute in to protocol specific formats, never null

getDependencies

@Nonnull
@NonnullElements
public Set<ResolverPluginDependency> getDependencies()

Gets the unmodifiable list of dependencies for this plugin.

Specified by:

getDependencies in interface ResolverPlugin<IdPAttribute>

Overrides:

getDependencies in class AbstractResolverPlugin<IdPAttribute>

Returns:

unmodifiable list of dependencies for this plugin, never null

getDisplayDescriptions

@Nonnull
@NonnullElements
public Map<Locale,String> getDisplayDescriptions()

Gets the localized human readable descriptions of attribute.

Specified by:

getDisplayDescriptions in interface AttributeDefinition

Overrides:

getDisplayDescriptions in class AbstractAttributeDefinition

Returns:

human readable descriptions of attribute

getDisplayNames

@Nonnull
@NonnullElements
public Map<Locale,String> getDisplayNames()

Gets the localized human readable names of the attribute.

Specified by:

getDisplayNames in interface AttributeDefinition

Overrides:

getDisplayNames in class AbstractAttributeDefinition

Returns:

human readable names of the attribute

getActivationCondition

@Nullable
public com.google.common.base.Predicate<ProfileRequestContext> getActivationCondition()

Get the predicate which defines whether this plugin is active for a given request.

Specified by:

getActivationCondition in interface ResolverPlugin<IdPAttribute>

Overrides:

getActivationCondition in class AbstractResolverPlugin<IdPAttribute>

Returns:

the predicate.

getId

@Nonnull
public String getId()

Specified by:

getId in interface IdentifiedComponent

Overrides:

getId in class AbstractIdentifiedInitializableComponent

getResolvedAttribute

@Nullable
public IdPAttribute getResolvedAttribute()

Gets the resolved attribute.

Returns:

resolved attribute, or null

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractResolverPlugin<IdPAttribute>

isDependencyOnly

public boolean isDependencyOnly()

Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.

Specified by:

isDependencyOnly in interface AttributeDefinition

Overrides:

isDependencyOnly in class AbstractAttributeDefinition

Returns:

true if this attribute is only used as a dependency, false otherwise

isPropagateResolutionExceptions

public boolean isPropagateResolutionExceptions()

Get whether a ResolutionException that occurred resolving attributes will be re-thrown. Doing so will cause the entire attribute resolution request to fail.

Specified by:

isPropagateResolutionExceptions in interface ResolverPlugin<IdPAttribute>

Overrides:

isPropagateResolutionExceptions in class AbstractResolverPlugin<IdPAttribute>

Returns:

true if ResolutionExceptions are propagated, false if not

setDependencyOnly

public void setDependencyOnly(boolean isDependencyOnly)

Sets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.

Overrides:

setDependencyOnly in class AbstractAttributeDefinition

Parameters:

isDependencyOnly - whether this attribute definition is only a dependency

setDisplayDescriptions

public void setDisplayDescriptions(Map<Locale,String> descriptions)

Sets the localized human readable descriptions of attribute.

Overrides:

setDisplayDescriptions in class AbstractAttributeDefinition

Parameters:

descriptions - localized human readable descriptions of attribute

setDisplayNames

public void setDisplayNames(Map<Locale,String> names)

Sets the localized human readable names of the attribute.

Overrides:

setDisplayNames in class AbstractAttributeDefinition

Parameters:

names - localized human readable names of the attribute

setPropagateResolutionExceptions

public void setPropagateResolutionExceptions(boolean propagate)

Set whether an AttributeResolutionContext that occurred resolving attributes will be re-thrown. Doing so will cause the entire attribute resolution request to fail.

Overrides:

setPropagateResolutionExceptions in class AbstractResolverPlugin<IdPAttribute>

Parameters:

propagate - true if ResolutionExceptions are propagated, false if not

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

getResolvedDefinition

@Nonnull
public AttributeDefinition getResolvedDefinition()

Gets the wrapped attribute definition that was resolved.

Returns:

the resolved attribute definition

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface InitializableComponent

Overrides:

isInitialized in class AbstractInitializableComponent