net.geant.edugain.attributes
Class AttributeConverter

java.lang.Object
  net.geant.edugain.attributes.AttributeConverter

public class AttributeConverter
extends java.lang.Object

Attribute Converter class. This class is the 'main' class for attribute conversion. Bridging elements SHOULD initialize AttributeConverter in configuration time. Instantiate CAN be done via the the AttributeConverterFactory class.

Author:

Adam Lantos

Field Summary

protected java.util.List<Rule>	conversionRules Attribute conversion rules.
private org.apache.log4j.Logger	log

Constructor Summary

AttributeConverter()

Method Summary

void	init(AttributeConversionRulesType configuration) Initializes this converter with attribute conversion configuration.
java.util.List<AttributeValues>	process(java.util.List<AttributeValues> input, java.lang.String remoteProvider) Process the attributes according to the conversion rules.
java.util.List<AttributeValues>	process(java.util.List<AttributeValues> input, java.lang.String remoteProvider, java.lang.String localProvider) Process the attributes according to the conversion rules.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

conversionRules

protected java.util.List<Rule> conversionRules

Attribute conversion rules.

log

private org.apache.log4j.Logger log

Constructor Detail

AttributeConverter

public AttributeConverter()

Method Detail

init

public void init(AttributeConversionRulesType configuration)

Initializes this converter with attribute conversion configuration. Configuration is stored in XML format and constrainted by AttributeConverter.xsd. Configuration parsing is done by leveraging JAXB (Java API for XML Binding). AttributeConverterConfigurator SHOULD be used to help XML - Java mapping. JAXB classes are placed in net.geant.edugain.attributes.jaxb.* packages.

Parameters:

configuration - java instance of configuration data

See Also:

AttributeConverterConfigurator, AttributeConverterFactory, AttributeConversionRulesType

process

public java.util.List<AttributeValues> process(java.util.List<AttributeValues> input,
                                               java.lang.String remoteProvider,
                                               java.lang.String localProvider)

Process the attributes according to the conversion rules. This is just a template method - it calls all the configured conversionRules in order and then returns. Any exception thrown by the rule is not considered to be a fatal error.

Parameters:

input -

remoteProvider - String

localProvider - String

Returns:

output

process

public java.util.List<AttributeValues> process(java.util.List<AttributeValues> input,
                                               java.lang.String remoteProvider)

Process the attributes according to the conversion rules.

Parameters:

input -

remoteProvider -

Returns:

output List