edu.internet2.middleware.shibboleth.common.attribute.resolver.provider
Interface ResolutionPlugIn<ResolvedType>

Type Parameters:
ResolvedType - object type this plug-in resolves to
All Known Subinterfaces:
AttributeDefinition, DataConnector, PrincipalConnector
All Known Implementing Classes:
AbstractResolutionPlugIn, BaseAttributeDefinition, BaseDataConnector, BasePrincipalConnector, ComputedIDDataConnector, ContextualAttributeDefinition, ContextualDataConnector, ContextualPrincipalConnector, DirectPrincipalConnector, LdapDataConnector, MappedAttributeDefinition, PrescopedAttributeDefinition, PrincipalAuthenticationMethodDefinition, PrincipalNameDefinition, RDBMSDataConnector, RegexSplitAttributeDefinition, SAML1NameIdentifierAttributeDefinition, SAML2NameIDAttributeDefinition, ScopedAttributeDefinition, ScriptedAttributeDefinition, SimpleAttributeDefinition, StaticDataConnector, StoredIDDataConnector, StoredIDPrincipalConnector, TemplateAttributeDefinition, TransientIdAttributeDefinition, TransientPrincipalConnector

public interface ResolutionPlugIn<ResolvedType>

A base interface for plugins that provide attributes.


Method Summary
 List<String> getDependencyIds()
          Gets the IDs of the resolution plugins this plugin is dependent on.
 String getId()
          Returns the unique ID of the plugin.
 ResolvedType resolve(ShibbolethResolutionContext resolutionContext)
          Performs the attribute resolution for this plugin.
 void validate()
          Validate the internal state of this plug-in.
 

Method Detail

getId

String getId()
Returns the unique ID of the plugin.

Returns:
unique ID of the plugin

getDependencyIds

List<String> getDependencyIds()
Gets the IDs of the resolution plugins this plugin is dependent on.

Returns:
IDs of the data connectors this plugin is dependent on

resolve

ResolvedType resolve(ShibbolethResolutionContext resolutionContext)
                     throws AttributeResolutionException
Performs the attribute resolution for this plugin.

Parameters:
resolutionContext - the context for the resolution
Returns:
the attributes made available by the resolution, never null
Throws:
AttributeResolutionException - the problem that occurred during the resolution

validate

void validate()
              throws AttributeResolutionException
Validate the internal state of this plug-in. This process may not rely on information from any dependency.

Throws:
AttributeResolutionException - if the plug-in has an invalid internal state


Copyright © 2006-2011 Internet2. All Rights Reserved.