edu.internet2.middleware.shibboleth.common.attribute.provider
Interface SAML2AttributeAuthority

All Superinterfaces:
AttributeAuthority<SAMLProfileRequestContext<? extends org.opensaml.saml2.core.RequestAbstractType,? extends org.opensaml.saml2.core.StatusResponseType,org.opensaml.saml2.core.NameID,? extends AbstractSAML2ProfileConfiguration>>
All Known Implementing Classes:
ShibbolethSAML2AttributeAuthority

public interface SAML2AttributeAuthority
extends AttributeAuthority<SAMLProfileRequestContext<? extends org.opensaml.saml2.core.RequestAbstractType,? extends org.opensaml.saml2.core.StatusResponseType,org.opensaml.saml2.core.NameID,? extends AbstractSAML2ProfileConfiguration>>

An attribute authority that can take an attribute query and produce a resultant attribute statement.


Method Summary
 org.opensaml.saml2.core.AttributeStatement buildAttributeStatement(org.opensaml.saml2.core.AttributeQuery query, Collection<BaseAttribute> attributes)
          Creates a SAML 2 attribute statment from a collection of BaseAttribute.
 String getAttributeIDBySAMLAttribute(org.opensaml.saml2.core.Attribute attribute)
          Translates SAML 2 attribute naming information into the internal attribute ID used by the resolver and filtering engine.
 String getPrincipal(SAMLProfileRequestContext<? extends org.opensaml.saml2.core.RequestAbstractType,? extends org.opensaml.saml2.core.StatusResponseType,org.opensaml.saml2.core.NameID,? extends AbstractSAML2ProfileConfiguration> requestContext)
          Resolves a NameID into the internal principal name used Shibboleth.
 org.opensaml.saml2.core.Attribute getSAMLAttributeByAttributeID(String id)
          Translates the internal attribute ID, used by the resolver and filtering engine, into its representative SAML 2 attribute name.
 
Methods inherited from interface edu.internet2.middleware.shibboleth.common.attribute.AttributeAuthority
getAttributes
 

Method Detail

getPrincipal

String getPrincipal(SAMLProfileRequestContext<? extends org.opensaml.saml2.core.RequestAbstractType,? extends org.opensaml.saml2.core.StatusResponseType,org.opensaml.saml2.core.NameID,? extends AbstractSAML2ProfileConfiguration> requestContext)
                    throws AttributeRequestException
Resolves a NameID into the internal principal name used Shibboleth.

Parameters:
requestContext - The request context within which to retrieve the principal. At a mimium, a NameID and relying party ID must be included.
Returns:
NameID into the internal principal name used Shibboleth
Throws:
AttributeRequestException - thrown if the principal get not be resolved

buildAttributeStatement

org.opensaml.saml2.core.AttributeStatement buildAttributeStatement(org.opensaml.saml2.core.AttributeQuery query,
                                                                   Collection<BaseAttribute> attributes)
                                                                   throws AttributeEncodingException
Creates a SAML 2 attribute statment from a collection of BaseAttribute.

Parameters:
query - the attribute query the statement is in respone to, may be null
attributes - the attributes to create the attribute statement form
Returns:
the generated attribute statement
Throws:
AttributeEncodingException - thrown if an BaseAttribute can not be encoded

getAttributeIDBySAMLAttribute

String getAttributeIDBySAMLAttribute(org.opensaml.saml2.core.Attribute attribute)
Translates SAML 2 attribute naming information into the internal attribute ID used by the resolver and filtering engine.

Parameters:
attribute - the SAML 2 attribute to translate
Returns:
the attribute ID used by the resolver and filtering engine

getSAMLAttributeByAttributeID

org.opensaml.saml2.core.Attribute getSAMLAttributeByAttributeID(String id)
Translates the internal attribute ID, used by the resolver and filtering engine, into its representative SAML 2 attribute name.

Parameters:
id - internal attribute ID
Returns:
SAML 2 attribute name


Copyright © 2006-2009 Internet2. All Rights Reserved.