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

Class IdPInitiatedSSORequestMessageDecoder

java.lang.Object

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

org.opensaml.messaging.decoder.AbstractMessageDecoder

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

net.shibboleth.idp.saml.profile.impl.BaseIdPInitiatedSSORequestMessageDecoder

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder, HttpServletRequestMessageDecoder, SAMLMessageDecoder

public class IdPInitiatedSSORequestMessageDecoder
extends BaseIdPInitiatedSSORequestMessageDecoder
implements SAMLMessageDecoder

Decodes an incoming Shibboleth Authentication Request message.

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	BINDING_URI	Protocol binding implemented by this decoder.
private final SAMLObjectBuilder<Issuer>	issuerBuilder	Builder of SAML 2 Issuer objects.
private final org.slf4j.Logger	log	Class logger.
private final SAMLObjectBuilder<NameIDPolicy>	nipBuilder	Builder of SAML 2 NameIDPolicy objects.
private final SAMLObjectBuilder<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	Description
IdPInitiatedSSORequestMessageDecoder()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected 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(MessageContext 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

doInitialize, getHttpServletRequest, getHttpServletRequestSupplier, setHttpServletRequest, setHttpServletRequestSupplier

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

doDestroy, 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 net.shibboleth.utilities.java.support.component.DestructableComponent

destroy, isDestroyed

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

initialize, isInitialized

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

decode, getMessageContext

Field Details

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 SAMLObjectBuilder<AuthnRequest> requestBuilder

Builder of SAML 2 AuthnRequest objects.

issuerBuilder

private final SAMLObjectBuilder<Issuer> issuerBuilder

Builder of SAML 2 Issuer objects.

nipBuilder

private final SAMLObjectBuilder<NameIDPolicy> nipBuilder

Builder of SAML 2 NameIDPolicy objects.

ssoRequest

@Nullable
private IdPInitiatedSSORequest ssoRequest

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

Constructor Details

IdPInitiatedSSORequestMessageDecoder

public IdPInitiatedSSORequestMessageDecoder()

Constructor.

Method Details

getBindingURI

@Nonnull
@NotEmpty
public String getBindingURI()

Specified by:

getBindingURI in interface SAMLMessageDecoder

getIdPInitiatedSSORequest

@Nullable
protected IdPInitiatedSSORequest getIdPInitiatedSSORequest()

Get the internally constructed instance of IdPInitiatedSSORequest.

Returns:

the internal SSO request instance

doDecode

protected void doDecode()
                 throws MessageDecodingException

Specified by:

doDecode in class AbstractMessageDecoder

Throws:

MessageDecodingException

buildAuthnRequest

@Nonnull
protected AuthnRequest buildAuthnRequest()
                                  throws MessageDecodingException

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

Returns:

the synthetic AuthnRequest message instance

Throws:

MessageDecodingException - if the inbound request does not contain an entityID value

populateBindingContext

protected void populateBindingContext(@Nonnull
 MessageContext 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

Returns:

the string representing the protocol message for logging purposes