net.shibboleth.idp.attribute.resolver

Class AbstractAttributeDefinition

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

All Implemented Interfaces:

AttributeDefinition, ResolverPlugin<IdPAttribute>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.UnmodifiableComponent, DisposableBean

Direct Known Subclasses:

ResolvedAttributeDefinition

@ThreadSafe
public abstract class AbstractAttributeDefinition
extends AbstractResolverPlugin<IdPAttribute>
implements AttributeDefinition

Base class for attribute definition resolver plugins.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	dependencyOnly Whether this attribute definition is only a dependency and thus its values should never be released.
private Map<Locale,String>	displayDescriptions Localized human readable description of attribute.
private Map<Locale,String>	displayNames Localized human intelligible attribute name.
private Set<AttributeEncoder<?>>	encoders Attribute encoders associated with this definition.
private Logger	log Class logger.
private String	logPrefix cache for the log prefix - to save multiple recalculations.
private String	sourceAttributeID The sourceAttributeID attributeName.

Constructor Summary

Constructors

Constructor and Description
AbstractAttributeDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract IdPAttribute	doAttributeDefinitionResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext) Creates and populates the values for the resolved attribute.
protected void	doInitialize()
protected IdPAttribute	doResolve(AttributeResolutionContext resolutionContext, AttributeResolverWorkContext workContext) Perform the actual resolution.
Set<AttributeEncoder<?>>	getAttributeEncoders() Gets the unmodifiable encoders used to encode the values of this attribute in to protocol specific formats.
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.
protected String	getLogPrefix() return a string which is to be prepended to all log messages.
String	getSourceAttributeId() Gets the source attribute id.
boolean	isDependencyOnly() Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.
void	setAttributeEncoders(Set<AttributeEncoder<?>> attributeEncoders) Sets the encoders used to encode the values of this attribute in to protocol specific formats.
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	setSourceAttributeId(String attributeId) Sets the source attribute id.

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 Logger log

Class logger.

dependencyOnly

private boolean dependencyOnly

Whether this attribute definition is only a dependency and thus its values should never be released.

sourceAttributeID

@Nullable
private String sourceAttributeID

The sourceAttributeID attributeName.

encoders

@Nonnull
private Set<AttributeEncoder<?>> encoders

Attribute encoders associated with this definition.

displayNames

@Nonnull
private Map<Locale,String> displayNames

Localized human intelligible attribute name.

displayDescriptions

@Nonnull
private Map<Locale,String> displayDescriptions

Localized human readable description of attribute.

logPrefix

@Nullable
private String logPrefix

cache for the log prefix - to save multiple recalculations.

Constructor Detail

AbstractAttributeDefinition

public AbstractAttributeDefinition()

Method Detail

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

Returns:

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

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.

Parameters:

isDependencyOnly - whether this attribute definition is only a dependency

getDisplayDescriptions

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

Gets the localized human readable descriptions of attribute.

Specified by:

getDisplayDescriptions in interface AttributeDefinition

Returns:

human readable descriptions of attribute

setDisplayDescriptions

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

Sets the localized human readable descriptions of attribute.

Parameters:

descriptions - localized human readable descriptions of attribute

getDisplayNames

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

Gets the localized human readable names of the attribute.

Specified by:

getDisplayNames in interface AttributeDefinition

Returns:

human readable names of the attribute

setDisplayNames

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

Sets the localized human readable names of the attribute.

Parameters:

names - localized human readable names of the attribute

getAttributeEncoders

@Nonnull
@NonnullElements
@Unmodifiable
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

Returns:

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

setAttributeEncoders

public void setAttributeEncoders(@Nullable@NullableElements
                        Set<AttributeEncoder<?>> attributeEncoders)

Sets the encoders used to encode the values of this attribute in to protocol specific formats.

Parameters:

attributeEncoders - encoders used to encode the values of this attribute in to protocol specific formats

getSourceAttributeId

public String getSourceAttributeId()

Gets the source attribute id.

Returns:

the source attribute id

setSourceAttributeId

public void setSourceAttributeId(String attributeId)

Sets the source attribute id.

Parameters:

attributeId - the source attribute id

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class AbstractResolverPlugin<IdPAttribute>

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

doResolve

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

Perform the actual resolution. The resolved attribute(s) should not be recorded in the work context. This method delegates the actual resolution of the attribute's values to the #doAttributeDefinitionResolve(AttributeResolutionContext) method. Afterwards, if null was not returned, this method will attach the registered display names, descriptions, and encoders to the resultant attribute.

Specified by:

doResolve in class AbstractResolverPlugin<IdPAttribute>

Parameters:

resolutionContext - current resolution context

workContext - child context where intermediate results are tracked

Returns:

the resolved attributes or null if no attributes were resolved

Throws:

ResolutionException - thrown if there is a problem resolving the attributes

See Also:

AbstractResolverPlugin.resolve(AttributeResolutionContext)

doAttributeDefinitionResolve

@Nullable
protected abstract 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.

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

getLogPrefix

@Nonnull
@NotEmpty
protected String getLogPrefix()

return a string which is to be prepended to all log messages.

Returns:

"Attribute Definition '' :"