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

Class PrincipalNameDefinition

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn<BaseAttribute>

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.BaseAttributeDefinition

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.PrincipalNameDefinition

All Implemented Interfaces:

AttributeDefinition, ResolutionPlugIn<BaseAttribute>

public class PrincipalNameDefinition
extends BaseAttributeDefinition

Attribute definition that exposes the user's principal name as an attribute.

Constructor Summary

Constructors

Constructor and Description
PrincipalNameDefinition()

Method Summary

Methods

Modifier and Type	Method and Description
protected BaseAttribute<String>	doResolve(ShibbolethResolutionContext resolutionContext) Creates and populates the values for the resolved attribute.
void	validate() Validate the internal state of this plug-in.

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.attributeDefinition.BaseAttributeDefinition

getAttributeEncoders, getDisplayDescriptions, getDisplayNames, getSourceAttributeID, getValuesFromAllDependencies, isDependencyOnly, resolve, setDependencyOnly, setSourceAttributeID

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn

getDependencyIds, getId, getValuesFromAllDependencies, getValuesFromAttributeDependency, getValuesFromConnectorDependency, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn

getDependencyIds, getId

Constructor Detail

PrincipalNameDefinition

public PrincipalNameDefinition()

Method Detail

doResolve

protected BaseAttribute<String> doResolve(ShibbolethResolutionContext resolutionContext)

Creates and populates the values for the resolved attribute. Implementations should *not* set, or otherwise manage, the attribute encoders for the resolved attribute.

Specified by:

doResolve in class BaseAttributeDefinition

Parameters:

resolutionContext - current attribute resolution context

Returns:

resolved attribute

validate

public 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