edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition
Interface AttributeDefinition

All Superinterfaces:
ResolutionPlugIn<BaseAttribute>
All Known Implementing Classes:
BaseAttributeDefinition, ContextualAttributeDefinition, MappedAttributeDefinition, PrescopedAttributeDefinition, PrincipalAuthenticationMethodDefinition, PrincipalNameDefinition, RegexSplitAttributeDefinition, SAML1NameIdentifierAttributeDefinition, SAML2NameIDAttributeDefinition, ScopedAttributeDefinition, ScriptedAttributeDefinition, SimpleAttributeDefinition, TemplateAttributeDefinition, TransientIdAttributeDefinition

public interface AttributeDefinition
extends ResolutionPlugIn<BaseAttribute>

A plugin used to create attributes or refine attributes provided from DataConnectors. Attribute definitions must be stateless and thread-safe as a single instance may be used to service every request.


Method Summary
 List<AttributeEncoder> getAttributeEncoders()
          Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category.
 Map<Locale,String> getDisplayDescriptions()
          Gets the localized human readable description of attribute.
 Map<Locale,String> getDisplayNames()
          Gets the localized human readable name 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 edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn
getDependencyIds, getId, resolve, validate
 

Method Detail

getDisplayDescriptions

Map<Locale,String> getDisplayDescriptions()
Gets the localized human readable description of attribute.

Returns:
human readable description of attribute

getDisplayNames

Map<Locale,String> getDisplayNames()
Gets the localized human readable name of the attribute.

Returns:
human readable name of the attribute

getAttributeEncoders

List<AttributeEncoder> getAttributeEncoders()
Gets the map of encoders to be added to attributes produced by this definition, keyed on encoder category.

Returns:
encoders to be added to attributes produced by this definition

isDependencyOnly

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

Returns:
whether this attribute definition is only a dependency


Copyright © 2006-2009 Internet2. All Rights Reserved.