net.shibboleth.idp.attribute.resolver

Interface AttributeDefinition

All Superinterfaces:

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

All Known Implementing Classes:

AbstractAttributeDefinition, ResolvedAttributeDefinition

@ThreadSafe
public interface AttributeDefinition
extends ResolverPlugin<IdPAttribute>

Definition of attribute definition resolver plugins.

Method Summary

Methods

Modifier and Type	Method and Description
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.
boolean	isDependencyOnly() Gets whether this attribute definition is only a dependency and thus its values should never be released outside the resolver.

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

Method Detail

isDependencyOnly

boolean isDependencyOnly()

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

Returns:

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

getDisplayDescriptions

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

Gets the localized human readable descriptions of attribute.

Returns:

human readable descriptions of attribute

getDisplayNames

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

Gets the localized human readable names of the attribute.

Returns:

human readable names of the attribute

getAttributeEncoders

@NonnullAfterInit
@NonnullElements
@Unmodifiable
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.

Returns:

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