Writing a Custom Attribute Definition

If the current attribute definitions do not meet your needs you may write a custom one. This is a fairly simple process:

Create a class that extends edu.internet2.middleware.shibboleth.aa.attrresolv.provider.BaseAttributeDefinition
Create a constructor that takes an org.w3c.dom.Element and be sure to call super(Element)
Implement the logic to fetch attribtues in the resolve(ResolverAttribute, Principal, String, String, Dependencies) method
Deploy your new definition within the !IdP; the extension mechanism provides a simple means to do this

By extending the BaseAttributeDefinition and calling its constructor it will take care of processing id, cacheTime, propagateErrors, and sourceName attributes as well as any DataConnectorDependency and AttributeDependency elements within your connector's configuration.

Configuring the Definition

Create a CustomAttributeDefinition element, with its id attribute, and the following attribute:
- class - the fully qualified name of your custom connector class
Define any additional XML attributes or elements required to configure your class

Example Configuration

This uses the Scriplet definition as if it were a custom definition to demonstrate using additional XML information to configure the connector.


< CustomAttributeDefinition id="urn:mace:dir:attribute-def:eduPersonAffiliation"
    class="edu.internet2.middleware.shibboleth.aa.attrresolv.provider.ScriptletAttributeDefinition">
	 <DataConnectorDependency requires="directory"/>
	 <Scriptlet>
		  <![CDATA[
				Attributes attributes = dependencies.getConnectorResolution("directory");
				Attribute affiliation = attributes.get("eduPersonAffiliation");
				if (affiliation.size() > 0) {
					 resolverAttribute.addValue("affiliate");
				}
		  ]]>
	 </Scriptlet>
</CustomAttributeDefinition >