net.shibboleth.idp.saml.saml2.profile.impl

Class IdPInitiatedSSORequestMessageDecoder

java.lang.Object

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

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

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

net.shibboleth.idp.saml.profile.impl.BaseIdPInitiatedSSORequestMessageDecoder<org.opensaml.saml.common.SAMLObject>

net.shibboleth.idp.saml.saml2.profile.impl.IdPInitiatedSSORequestMessageDecoder

All Implemented Interfaces:

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

public class IdPInitiatedSSORequestMessageDecoder
extends BaseIdPInitiatedSSORequestMessageDecoder<org.opensaml.saml.common.SAMLObject>
implements org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder

Decodes an incoming Shibboleth Authentication Request message.

Field Summary

Fields

Modifier and Type	Field and Description
private static String	BINDING_URI Protocol binding implemented by this decoder.
private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.Issuer>	issuerBuilder Builder of SAML 2 Issuer objects.
private org.slf4j.Logger	log Class logger.
private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.NameIDPolicy>	nipBuilder Builder of SAML 2 NameIDPolicy objects.
private org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.AuthnRequest>	requestBuilder Builder of SAML 2 AuthnRequest objects.
private IdPInitiatedSSORequest	ssoRequest The IdP-initiated request structure parsed from the inbound request.

Fields inherited from class net.shibboleth.idp.saml.profile.impl.BaseIdPInitiatedSSORequestMessageDecoder

PROVIDER_ID_PARAM, SHIRE_PARAM, TARGET_PARAM, TIME_PARAM

Constructor Summary

Constructors

Constructor and Description
IdPInitiatedSSORequestMessageDecoder() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected org.opensaml.saml.saml2.core.AuthnRequest	buildAuthnRequest() Build a synthetic AuthnRequest instance from the IdP-initiated SSO request structure.
protected void	doDecode()
String	getBindingURI()
protected IdPInitiatedSSORequest	getIdPInitiatedSSORequest() Get the internally constructed instance of IdPInitiatedSSORequest.
protected String	getMessageToLog() Get the string representation of what will be logged as the protocol message.
protected void	populateBindingContext(org.opensaml.messaging.context.MessageContext<org.opensaml.saml.common.SAMLObject> messageContext) Populate the context which carries information specific to this binding.

Methods inherited from class net.shibboleth.idp.saml.profile.impl.BaseIdPInitiatedSSORequestMessageDecoder

buildIdPInitiatedSSORequest, decode, getAcsUrl, getBindingDescriptor, getEntityId, getMessageID, getTarget, getTime, logDecodedMessage, setBindingDescriptor

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

doDestroy, doInitialize, 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

BINDING_URI

@Nonnull
@NotEmpty
private static final String BINDING_URI

Protocol binding implemented by this decoder.

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

requestBuilder

private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.AuthnRequest> requestBuilder

Builder of SAML 2 AuthnRequest objects.

issuerBuilder

private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.Issuer> issuerBuilder

Builder of SAML 2 Issuer objects.

nipBuilder

private final org.opensaml.saml.common.SAMLObjectBuilder<org.opensaml.saml.saml2.core.NameIDPolicy> nipBuilder

Builder of SAML 2 NameIDPolicy objects.

ssoRequest

@Nullable
private IdPInitiatedSSORequest ssoRequest

The IdP-initiated request structure parsed from the inbound request.

Constructor Detail

IdPInitiatedSSORequestMessageDecoder

public IdPInitiatedSSORequestMessageDecoder()

Constructor.

Method Detail

getBindingURI

@Nonnull
@NotEmpty
public String getBindingURI()

Specified by:

getBindingURI in interface org.opensaml.saml.common.binding.decoding.SAMLMessageDecoder

getIdPInitiatedSSORequest

@Nullable
protected IdPInitiatedSSORequest getIdPInitiatedSSORequest()

Get the internally constructed instance of IdPInitiatedSSORequest.

Returns:

the internal SSO request instance

doDecode

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

Specified by:

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

Throws:

org.opensaml.messaging.decoder.MessageDecodingException

buildAuthnRequest

@Nonnull
protected org.opensaml.saml.saml2.core.AuthnRequest buildAuthnRequest()
                                                               throws org.opensaml.messaging.decoder.MessageDecodingException

Build a synthetic AuthnRequest instance from the IdP-initiated SSO request structure.

Returns:

the synthetic AuthnRequest message instance

Throws:

org.opensaml.messaging.decoder.MessageDecodingException - if the inbound request does not contain an entityID value

populateBindingContext

protected void populateBindingContext(@Nonnull
                          org.opensaml.messaging.context.MessageContext<org.opensaml.saml.common.SAMLObject> messageContext)

Populate the context which carries information specific to this binding.

Parameters:

messageContext - the current message context

getMessageToLog

@Nullable
protected String getMessageToLog()

Get the string representation of what will be logged as the protocol message.

Specified by:

getMessageToLog in class BaseIdPInitiatedSSORequestMessageDecoder<org.opensaml.saml.common.SAMLObject>

Returns:

the string representing the protocol message for logging purposes