edu.internet2.middleware.shibboleth.idp.profile.saml1
Class AttributeQueryProfileHandler

java.lang.Object
  edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler<HTTPInTransport,HTTPOutTransport>
      edu.internet2.middleware.shibboleth.common.profile.provider.AbstractShibbolethProfileHandler<SAMLMDRelyingPartyConfigurationManager,Session>
          edu.internet2.middleware.shibboleth.idp.profile.AbstractSAMLProfileHandler
              edu.internet2.middleware.shibboleth.idp.profile.saml1.AbstractSAML1ProfileHandler
                  edu.internet2.middleware.shibboleth.idp.profile.saml1.AttributeQueryProfileHandler

All Implemented Interfaces:

ProfileHandler<HTTPInTransport,HTTPOutTransport>

public class AttributeQueryProfileHandler
extends AbstractSAML1ProfileHandler

SAML 1 Attribute Query profile handler.

Nested Class Summary

protected class

AttributeQueryProfileHandler.AttributeQueryContext Basic data structure used to accumulate information as a request is being processed.

Nested classes/interfaces inherited from class edu.internet2.middleware.shibboleth.idp.profile.saml1.AbstractSAML1ProfileHandler

AbstractSAML1ProfileHandler.SAML1AuditLogEntry

Field Summary

private SAMLObjectBuilder<AssertionConsumerService>	acsEndpointBuilder Builder of assertion consumer service endpoints.
private org.slf4j.Logger	log Class logger.
private SAMLObjectBuilder<NameIdentifier>	nameIdentifierBuilder Builder of NameIdentifier objects.

Fields inherited from class edu.internet2.middleware.shibboleth.idp.profile.saml1.AbstractSAML1ProfileHandler

SAML_VERSION

Constructor Summary

AttributeQueryProfileHandler()
Constructor.

Method Summary

protected NameIdentifier	buildNameId(BaseSAML1ProfileRequestContext<?,?,?> requestContext) Builds a NameIdentifier appropriate for this request.
protected void	decodeRequest(AttributeQueryProfileHandler.AttributeQueryContext requestContext, HTTPInTransport inTransport, HTTPOutTransport outTransport) Decodes an incoming request and populates a created request context with the resultant information.
String	getProfileId()
protected void	populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext) Populates the request context with information about the asserting party.
protected void	populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext) Populates the request context with information about the relying party.
protected void	populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext) Populates the request context with information from the inbound SAML message.
void	processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
protected Endpoint	selectEndpoint(BaseSAMLProfileRequestContext requestContext) Selects the appropriate endpoint for the relying party and stores it in the request context.

Methods inherited from class edu.internet2.middleware.shibboleth.idp.profile.saml1.AbstractSAML1ProfileHandler

buildAssertion, buildAttributeStatement, buildConditions, buildErrorResponse, buildResponse, buildStatus, buildSubject, checkSamlVersion, isSignAssertion, populateRequestContext, populateStatusResponse, populateUserInformation, resolveAttributes, resolvePrincipal, signAssertion, writeAuditLogEntry

Methods inherited from class edu.internet2.middleware.shibboleth.idp.profile.AbstractSAMLProfileHandler

encodeResponse, filterNameIDAttributesByFormats, filterNameIDAttributesByProtocol, getAduitLog, getEntitySupportedFormats, getIdGenerator, getInboundBinding, getInboundMessageDecoder, getMessageDecoders, getMessageEncoders, getMetadataCredentialResolver, getMetadataProvider, getOutboundMessageEncoder, getRelyingPartyConfiguration, getRequiredNameIDFormat, getSecurityPolicyResolver, getSupportedNameFormats, getSupportedOutboundBindings, getUserSession, getUserSession, isSignResponse, populateProfileInformation, selectNameIDAttributeAndEncoder, selectNameIDAttributeAndEncoder, setIdGenerator, setInboundBinding, setMessageDecoders, setMessageEncoders, setSecurityPolicyResolver, setSupportedOutboundBindings

Methods inherited from class edu.internet2.middleware.shibboleth.common.profile.provider.AbstractShibbolethProfileHandler

getBuilderFactory, getParserPool, getProfileConfiguration, getRelyingPartyConfigurationManager, getSessionManager, getStorageService, setParserPool, setRelyingPartyConfigurationManager, setSessionManager, setStorageService

Methods inherited from class edu.internet2.middleware.shibboleth.common.profile.provider.AbstractRequestURIMappedProfileHandler

getRequestPaths, setRequestPaths

Methods inherited from class java.lang.Object

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

Field Detail

log

private final org.slf4j.Logger log

Class logger.

nameIdentifierBuilder

private SAMLObjectBuilder<NameIdentifier> nameIdentifierBuilder

Builder of NameIdentifier objects.

acsEndpointBuilder

private SAMLObjectBuilder<AssertionConsumerService> acsEndpointBuilder

Builder of assertion consumer service endpoints.

Constructor Detail

AttributeQueryProfileHandler

public AttributeQueryProfileHandler()

Constructor.

Method Detail

getProfileId

public String getProfileId()

Specified by:

getProfileId in class AbstractShibbolethProfileHandler<SAMLMDRelyingPartyConfigurationManager,Session>

processRequest

public void processRequest(HTTPInTransport inTransport,
                           HTTPOutTransport outTransport)
                    throws ProfileException

Throws:

ProfileException

decodeRequest

protected void decodeRequest(AttributeQueryProfileHandler.AttributeQueryContext requestContext,
                             HTTPInTransport inTransport,
                             HTTPOutTransport outTransport)
                      throws ProfileException

Decodes an incoming request and populates a created request context with the resultant information.

Parameters:

inTransport - inbound message transport

outTransport - outbound message transport

requestContext - the request context to which decoded information should be added

Throws:

ProfileException - throw if there is a problem decoding the request

populateRelyingPartyInformation

protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
                                        throws ProfileException

Populates the request context with information about the relying party. This method requires the the following request context properties to be populated: inbound message issuer This methods populates the following request context properties: peer entityID, peer entity metadata, relying party configuration

Overrides:

populateRelyingPartyInformation in class AbstractSAMLProfileHandler

Parameters:

requestContext - current request context

Throws:

ProfileException - thrown if there is a problem looking up the relying party's metadata

populateAssertingPartyInformation

protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
                                          throws ProfileException

Populates the request context with information about the asserting party. Unless overridden, AbstractSAMLProfileHandler.populateRequestContext(BaseSAMLProfileRequestContext) has already invoked AbstractSAMLProfileHandler.populateRelyingPartyInformation(BaseSAMLProfileRequestContext) has already been invoked and the properties it provides are available in the request context. This method requires the the following request context properties to be populated: metadata provider, relying party configuration This methods populates the following request context properties: local entity ID, outbound message issuer, local entity metadata

Overrides:

populateAssertingPartyInformation in class AbstractSAMLProfileHandler

Parameters:

requestContext - current request context

Throws:

ProfileException - thrown if there is a problem looking up the asserting party's metadata

populateSAMLMessageInformation

protected void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext)
                                       throws ProfileException

Populates the request context with information from the inbound SAML message. This method requires the the following request context properties to be populated: inbound saml message This methods populates the following request context properties: subject name identifier

Specified by:

populateSAMLMessageInformation in class AbstractSAMLProfileHandler

Parameters:

requestContext - current request context

Throws:

ProfileException - thrown if the inbound SAML message or subject identifier is null

selectEndpoint

protected Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext)

Selects the appropriate endpoint for the relying party and stores it in the request context.

Specified by:

selectEndpoint in class AbstractSAMLProfileHandler

Parameters:

requestContext - current request context

Returns:

Endpoint selected from the information provided in the request context

buildNameId

protected NameIdentifier buildNameId(BaseSAML1ProfileRequestContext<?,?,?> requestContext)
                              throws ProfileException

Builds a NameIdentifier appropriate for this request. NameIdentifier are built by inspecting the SAML request and metadata, picking a name format that was requested by the relying party or is mutually supported by both the relying party and asserting party as described in their metadata entries. Once a set of supported name formats is determined the principals attributes are inspected for an attribute supported an attribute encoder whose category is one of the supported name formats.

Overrides:

buildNameId in class AbstractSAML1ProfileHandler

Parameters:

requestContext - current request context

Returns:

the NameIdentifier appropriate for this request

Throws:

ProfileException - thrown if a NameIdentifier can not be created either because there was a problem encoding the name ID attribute or because there are no supported name formats