edu.internet2.middleware.shibboleth.common.config.attribute.resolver.attributeDefinition
Class BaseAttributeDefinitionFactoryBean

java.lang.Object
  extended by org.springframework.beans.factory.config.AbstractFactoryBean
      extended by edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean
          extended by edu.internet2.middleware.shibboleth.common.config.attribute.resolver.attributeDefinition.BaseAttributeDefinitionFactoryBean
All Implemented Interfaces:
org.springframework.beans.factory.BeanClassLoaderAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.FactoryBean, org.springframework.beans.factory.InitializingBean
Direct Known Subclasses:
CryptoTransientIdAttributeDefinitionFactoryBean, MappedAttributeDefinitionFactoryBean, PrescopedAttributeDefinitionFactoryBean, PrincipalAuthenticationMethodAttributeDefinitionFactoryBean, PrincipalNameAttributeDefinitionFactoryBean, RegexSplitAttributeDefinitionFactoryBean, SAML1NameIdentifierAttributeDefinitionFactoryBean, SAML2NameIDAttributeDefinitionFactoryBean, ScopedAttributeDefinitionFactoryBean, ScriptedAttributeDefinitionFactoryBean, SimpleAttributeDefinitionFactoryBean, TemplateAttributeDefinitionFactoryBean, TransientIdAttributeDefinitionFactoryBean

public abstract class BaseAttributeDefinitionFactoryBean
extends AbstractResolutionPluginFactoryBean

Base Spring factory bean that produces attribute definitions.


Field Summary
private  List<AttributeEncoder> attributeEncoders
          Encoders for the attributes.
private  boolean dependencyOnly
          Whether attributes produced by the definition should be released outside the resolver.
private  Map<Locale,String> displayDescriptions
          Localized human readable description of attribute.
private  Map<Locale,String> displayNames
          Localized human intelligible attribute name.
private  String sourceAttributeId
          Attribute ID of the source attribute.
 
Fields inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
logger
 
Constructor Summary
BaseAttributeDefinitionFactoryBean()
           
 
Method Summary
 List<AttributeEncoder> getAttributeEncoders()
          Gets the encoders for the attributes.
 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.
 String getSourceAttributeId()
          Gets the ID of the attribute that serves as the source of information for the attribute definition.
 boolean isDependencyOnly()
          Gets whether attributes produced by the definition should be released outside the resolver.
protected  void populateAttributeDefinition(BaseAttributeDefinition definition)
          Populates the attribute definition with information from this factory.
 void setAttributeEncoders(List<AttributeEncoder> encoders)
          Sets the encoders for the attributes.
 void setDependencyOnly(boolean isDependencyOnly)
          Sets whether attributes produced by the definition should be released outside the resolver.
 void setDisplayDescriptions(Map<Locale,String> descriptions)
          Sets the human readable description of attribute.
 void setDisplayNames(Map<Locale,String> names)
          Sets the human readable name of the attribute.
 void setSourceAttributeId(String id)
          Sets the ID of the attribute that serves as the source of information for the attribute definition.
 
Methods inherited from class edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean
getDependencyIds, getPluginId, setDependencyIds, setPluginId
 
Methods inherited from class org.springframework.beans.factory.config.AbstractFactoryBean
afterPropertiesSet, createInstance, destroy, destroyInstance, getBeanFactory, getBeanTypeConverter, getEarlySingletonInterfaces, getObject, getObjectType, isSingleton, setBeanClassLoader, setBeanFactory, setSingleton
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

sourceAttributeId

private String sourceAttributeId
Attribute ID of the source attribute.


dependencyOnly

private boolean dependencyOnly
Whether attributes produced by the definition should be released outside the resolver.


attributeEncoders

private List<AttributeEncoder> attributeEncoders
Encoders for the attributes.


displayNames

private Map<Locale,String> displayNames
Localized human intelligible attribute name.


displayDescriptions

private Map<Locale,String> displayDescriptions
Localized human readable description of attribute.

Constructor Detail

BaseAttributeDefinitionFactoryBean

public BaseAttributeDefinitionFactoryBean()
Method Detail

getAttributeEncoders

public List<AttributeEncoder> getAttributeEncoders()
Gets the encoders for the attributes.

Returns:
encoders for the attributes

getDisplayDescriptions

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

Returns:
human readable description of attribute

getDisplayNames

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

Returns:
human readable name of the attribute

getSourceAttributeId

public String getSourceAttributeId()
Gets the ID of the attribute that serves as the source of information for the attribute definition.

Returns:
ID of the attribute that serves as the source of information for the attribute definition

isDependencyOnly

public boolean isDependencyOnly()
Gets whether attributes produced by the definition should be released outside the resolver.

Returns:
whether attributes produced by the definition should be released outside the resolver

populateAttributeDefinition

protected void populateAttributeDefinition(BaseAttributeDefinition definition)
Populates the attribute definition with information from this factory.

Parameters:
definition - attribute definition to populate

setAttributeEncoders

public void setAttributeEncoders(List<AttributeEncoder> encoders)
Sets the encoders for the attributes.

Parameters:
encoders - encoders for the attributes

setDependencyOnly

public void setDependencyOnly(boolean isDependencyOnly)
Sets whether attributes produced by the definition should be released outside the resolver.

Parameters:
isDependencyOnly - whether attributes produced by the definition should be released outside the resolver

setDisplayDescriptions

public void setDisplayDescriptions(Map<Locale,String> descriptions)
Sets the human readable description of attribute.

Parameters:
descriptions - human readable descriptions of attribute

setDisplayNames

public void setDisplayNames(Map<Locale,String> names)
Sets the human readable name of the attribute.

Parameters:
names - human readable names of the attribute

setSourceAttributeId

public void setSourceAttributeId(String id)
Sets the ID of the attribute that serves as the source of information for the attribute definition.

Parameters:
id - ID of the attribute that serves as the source of information for the attribute definition


Copyright © 1999-2012. All Rights Reserved.