org.opensaml.saml.saml2.binding.decoding.impl

Class HTTPArtifactDecoder

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.decoder.AbstractMessageDecoder<MessageType>

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder<MessageType>

org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<SAMLObject>

org.opensaml.saml.saml2.binding.decoding.impl.HTTPArtifactDecoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, org.opensaml.messaging.decoder.MessageDecoder<SAMLObject>, org.opensaml.messaging.decoder.servlet.HttpServletRequestMessageDecoder<SAMLObject>, SAMLMessageDecoder

public class HTTPArtifactDecoder
extends org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<SAMLObject>
implements SAMLMessageDecoder

SAML 2 Artifact Binding decoder, support both HTTP GET and POST. NOTE: This decoder is not yet implemented.

Field Summary

Fields

Modifier and Type	Field and Description
private SAML2ArtifactBuilderFactory	artifactBuilderFactory SAML 2 artifact builder factory.
private EndpointResolver<ArtifactResolutionService>	artifactEndpointResolver Resolver for ArtifactResolutionService endpoints.
private BindingDescriptor	bindingDescriptor Optional BindingDescriptor to inject into SAMLBindingContext created.
private IdentifierGenerationStrategy	idStrategy Identifier generation strategy.
private org.slf4j.Logger	log Class logger.
private QName	peerEntityRole The peer entity role QName.
private RoleDescriptorResolver	roleDescriptorResolver Role descriptor resolver.
private org.opensaml.soap.client.SOAPClient	soapClient SOAP client.

Constructor Summary

Constructors

Constructor and Description
HTTPArtifactDecoder()

Method Summary

Modifier and Type	Method and Description
private ArtifactResolve	buildArtifactResolveRequestMessage(SAML2Artifact artifact, String endpoint, RoleDescriptor peerRoleDescriptor)
private Issuer	buildIssuer(RoleDescriptor peerRoleDescriptor)
private SAMLObject	dereferenceArtifact(SAML2Artifact artifact, RoleDescriptor peerRoleDescriptor, ArtifactResolutionService ars)
protected void	doDecode()
protected void	doDestroy()
protected void	doInitialize()
SAML2ArtifactBuilderFactory	getArtifactBuilderFactory() Get the SAML 2 artifact builder factory.
EndpointResolver<ArtifactResolutionService>	getArtifactEndpointResolver() Get the artifact endpoint resolver.
BindingDescriptor	getBindingDescriptor() Get an optional BindingDescriptor to inject into SAMLBindingContext created.
String	getBindingURI()
IdentifierGenerationStrategy	getIdentifierGenerationStrategy() Get the identifier generation strategy.
QName	getPeerEntityRole() Get the peer entity role QName.
RoleDescriptorResolver	getRoleDescriptorResolver() Get the role descriptor resolver.
org.opensaml.soap.client.SOAPClient	getSOAPClient() Get the SOAP client instance.
private SAML2Artifact	parseArtifact(String encodedArtifact)
protected void	populateBindingContext(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext) Populate the context which carries information specific to this binding.
private void	processArtifact(org.opensaml.messaging.context.MessageContext messageContext, HttpServletRequest request) Process the incoming artifact by decoding the artifacts, dereferencing it from the artifact issuer and storing the resulting protocol message in the message context.
private ArtifactResolutionService	resolveArtifactEndpoint(SAML2Artifact artifact, RoleDescriptor peerRoleDescriptor)
private RoleDescriptor	resolvePeerRoleDescriptor(SAML2Artifact artifact)
void	setArtifactBuilderFactory(SAML2ArtifactBuilderFactory factory) Set the SAML 2 artifact builder factory.
void	setArtifactEndpointResolver(EndpointResolver<ArtifactResolutionService> resolver) Set the artifact endpoint resolver.
void	setBindingDescriptor(BindingDescriptor descriptor) Set an optional BindingDescriptor to inject into SAMLBindingContext created.
void	setIdentifierGenerationStrategy(IdentifierGenerationStrategy strategy) Set the identifier generation strategy.
void	setPeerEntityRole(QName role) Set the peer entity role QName.
void	setRoleDescriptorResolver(RoleDescriptorResolver resolver) Set the role descriptor resolver.
void	setSOAPClient(org.opensaml.soap.client.SOAPClient client) Set the SOAP client instance.

Methods inherited from class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder

decode, getMessageToLog, getParserPool, logDecodedMessage, setParserPool, unmarshallMessage, validateHttpRequest

Methods inherited from class org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

getHttpServletRequest, setHttpServletRequest

Methods inherited from class org.opensaml.messaging.decoder.AbstractMessageDecoder

getMessageContext, setMessageContext

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensaml.messaging.decoder.MessageDecoder

decode, getMessageContext

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

bindingDescriptor

@Nullable
private BindingDescriptor bindingDescriptor

Optional BindingDescriptor to inject into SAMLBindingContext created.

artifactBuilderFactory

@NonnullAfterInit
private SAML2ArtifactBuilderFactory artifactBuilderFactory

SAML 2 artifact builder factory.

artifactEndpointResolver

@NonnullAfterInit
private EndpointResolver<ArtifactResolutionService> artifactEndpointResolver

Resolver for ArtifactResolutionService endpoints.

roleDescriptorResolver

@NonnullAfterInit
private RoleDescriptorResolver roleDescriptorResolver

Role descriptor resolver.

peerEntityRole

@NonnullAfterInit
private QName peerEntityRole

The peer entity role QName.

soapClient

private org.opensaml.soap.client.SOAPClient soapClient

SOAP client.

idStrategy

private IdentifierGenerationStrategy idStrategy

Identifier generation strategy.

Constructor Detail

HTTPArtifactDecoder

public HTTPArtifactDecoder()

Method Detail

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<SAMLObject>

Throws:

ComponentInitializationException

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class org.opensaml.messaging.decoder.servlet.BaseHttpServletRequestXMLMessageDecoder<SAMLObject>

getIdentifierGenerationStrategy

@NonnullAfterInit
public IdentifierGenerationStrategy getIdentifierGenerationStrategy()

Get the identifier generation strategy.

Returns:

Returns the identifier generation strategy

setIdentifierGenerationStrategy

public void setIdentifierGenerationStrategy(@Nullable
                                            IdentifierGenerationStrategy strategy)

Set the identifier generation strategy.

Parameters:

strategy - the identifier generation strategy

getPeerEntityRole

@NonnullAfterInit
public QName getPeerEntityRole()

Get the peer entity role QName.

Returns:

the peer entity role

setPeerEntityRole

public void setPeerEntityRole(@Nonnull
                              QName role)

Set the peer entity role QName.

Parameters:

role - the peer entity role

getArtifactEndpointResolver

@NonnullAfterInit
public EndpointResolver<ArtifactResolutionService> getArtifactEndpointResolver()

Get the artifact endpoint resolver.

Returns:

the endpoint resolver

setArtifactEndpointResolver

public void setArtifactEndpointResolver(@Nullable
                                        EndpointResolver<ArtifactResolutionService> resolver)

Set the artifact endpoint resolver.

Parameters:

resolver - the new resolver

getRoleDescriptorResolver

@NonnullAfterInit
public RoleDescriptorResolver getRoleDescriptorResolver()

Get the role descriptor resolver.

Must be capable of resolving descriptors based on ArtifactCriterion.

Returns:

the role descriptor resolver

setRoleDescriptorResolver

public void setRoleDescriptorResolver(@Nullable
                                      RoleDescriptorResolver resolver)

Set the role descriptor resolver.

Must be capable of resolving descriptors based on ArtifactCriterion.

Parameters:

resolver - the role descriptor resolver

getArtifactBuilderFactory

@NonnullAfterInit
public SAML2ArtifactBuilderFactory getArtifactBuilderFactory()

Get the SAML 2 artifact builder factory.

Returns:

the artifact builder factory in use

setArtifactBuilderFactory

public void setArtifactBuilderFactory(@Nullable
                                      SAML2ArtifactBuilderFactory factory)

Set the SAML 2 artifact builder factory.

Parameters:

factory - the artifact builder factory

getSOAPClient

@NonnullAfterInit
public org.opensaml.soap.client.SOAPClient getSOAPClient()

Get the SOAP client instance.

Returns:

the SOAP client

setSOAPClient

public void setSOAPClient(@Nonnull
                          org.opensaml.soap.client.SOAPClient client)

Set the SOAP client instance.

Parameters:

client - the SOAP client

getBindingURI

@Nonnull
 @NotEmpty
public String getBindingURI()

Specified by:

getBindingURI in interface SAMLMessageDecoder

getBindingDescriptor

@Nullable
public BindingDescriptor getBindingDescriptor()

Get an optional BindingDescriptor to inject into SAMLBindingContext created.

Returns:

binding descriptor

setBindingDescriptor

public void setBindingDescriptor(@Nullable
                                 BindingDescriptor descriptor)

Set an optional BindingDescriptor to inject into SAMLBindingContext created.

Parameters:

descriptor - a binding descriptor

doDecode

protected void doDecode()
                 throws org.opensaml.messaging.decoder.MessageDecodingException

Specified by:

doDecode in class org.opensaml.messaging.decoder.AbstractMessageDecoder<SAMLObject>

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

processArtifact

private void processArtifact(org.opensaml.messaging.context.MessageContext messageContext,
                             HttpServletRequest request)
                      throws org.opensaml.messaging.decoder.MessageDecodingException

Process the incoming artifact by decoding the artifacts, dereferencing it from the artifact issuer and storing the resulting protocol message in the message context.

Parameters:

messageContext - the message context being processed

request - the HTTP servlet request

Throws:

org.opensaml.messaging.decoder.MessageDecodingException - thrown if there is a problem decoding or dereferencing the artifact

dereferenceArtifact

private SAMLObject dereferenceArtifact(SAML2Artifact artifact,
                                       RoleDescriptor peerRoleDescriptor,
                                       ArtifactResolutionService ars)
                                throws org.opensaml.messaging.decoder.MessageDecodingException

Parameters:

artifact -

peerRoleDescriptor -

artifactResolveEndpointURL -

Returns:

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

buildArtifactResolveRequestMessage

private ArtifactResolve buildArtifactResolveRequestMessage(SAML2Artifact artifact,
                                                           String endpoint,
                                                           RoleDescriptor peerRoleDescriptor)

Parameters:

artifact -

endpoint -

peerRoleDescriptor -

Returns:

buildIssuer

private Issuer buildIssuer(RoleDescriptor peerRoleDescriptor)

Parameters:

peerRoleDescriptor -

Returns:

resolveArtifactEndpoint

private ArtifactResolutionService resolveArtifactEndpoint(SAML2Artifact artifact,
                                                          RoleDescriptor peerRoleDescriptor)
                                                   throws org.opensaml.messaging.decoder.MessageDecodingException

Parameters:

artifact -

peerRoleDescriptor -

Returns:

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

resolvePeerRoleDescriptor

private RoleDescriptor resolvePeerRoleDescriptor(SAML2Artifact artifact)
                                          throws org.opensaml.messaging.decoder.MessageDecodingException

Parameters:

artifact -

Returns:

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

parseArtifact

private SAML2Artifact parseArtifact(String encodedArtifact)
                             throws org.opensaml.messaging.decoder.MessageDecodingException

Parameters:

encodedArtifact -

Returns:

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

populateBindingContext

protected void populateBindingContext(org.opensaml.messaging.context.MessageContext<SAMLObject> messageContext)

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context