net.shibboleth.idp.saml.profile.impl

Class BaseIdPInitiatedSSORequestMessageDecoder<RequestType>

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<RequestType>

Type Parameters:

RequestType - type of decoded message

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder<RequestType>, HttpServletRequestMessageDecoder<RequestType>

Direct Known Subclasses:

IdPInitiatedSSORequestMessageDecoder, IdPInitiatedSSORequestMessageDecoder

@NotThreadSafe
public abstract class BaseIdPInitiatedSSORequestMessageDecoder<RequestType>
extends AbstractHttpServletRequestMessageDecoder<RequestType>

Decodes an incoming Shibboleth Authentication Request message.

Field Summary

Fields

Modifier and Type	Field and Description
private BindingDescriptor	bindingDescriptor Optional BindingDescriptor to inject into SAMLBindingContext created.
private IdentifierGenerationStrategy	idGenerator ID generator.
private org.slf4j.Logger	log Class logger.
private org.slf4j.Logger	protocolMessageLog Used to log protocol messages.
static String	PROVIDER_ID_PARAM Name of the query parameter carrying the service provider entity ID: "providerId" .
static String	SHIRE_PARAM Name of the query parameter carrying the service provider's assertion consumer service URL: "shire" .
static String	TARGET_PARAM Name of the query parameter carrying the service provider's target/RelayState information: "target" .
static String	TIME_PARAM Name of the query parameter carrying the current time at the service provider: "time" .

Constructor Summary

Constructors

Constructor and Description
BaseIdPInitiatedSSORequestMessageDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected IdPInitiatedSSORequest	buildIdPInitiatedSSORequest() Build a new IdP-initiated request structure from the inbound HTTP request.
void	decode()
protected String	getAcsUrl(javax.servlet.http.HttpServletRequest request) Gets the assertion consumer service URL for the service provider.
BindingDescriptor	getBindingDescriptor() Get an optional BindingDescriptor to inject into SAMLBindingContextSAMLBindingContext created.
protected String	getEntityId(javax.servlet.http.HttpServletRequest request) Gets the entity ID of the service provider.
protected String	getMessageID() Construct a message ID for the request.
protected abstract String	getMessageToLog() Get the string representation of what will be logged as the protocol message.
protected String	getTarget(javax.servlet.http.HttpServletRequest request) Gets the opaque relay state sent by the service provider.
protected Long	getTime(javax.servlet.http.HttpServletRequest request) Gets the current time, in milliseconds since the epoch, at the SP, if set.
protected void	logDecodedMessage() Log the decoded message to the protocol message logger.
void	setBindingDescriptor(BindingDescriptor descriptor) Set an optional BindingDescriptor to inject into SAMLBindingContextSAMLBindingContext created.

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

doDestroy, doInitialize, getHttpServletRequest, setHttpServletRequest

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

doDecode, 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

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

PROVIDER_ID_PARAM

@Nonnull
@NotEmpty
public static final String PROVIDER_ID_PARAM

Name of the query parameter carrying the service provider entity ID: "providerId" .

See Also:

Constant Field Values

SHIRE_PARAM

@Nonnull
@NotEmpty
public static final String SHIRE_PARAM

Name of the query parameter carrying the service provider's assertion consumer service URL: "shire" .

See Also:

Constant Field Values

TARGET_PARAM

@Nonnull
@NotEmpty
public static final String TARGET_PARAM

Name of the query parameter carrying the service provider's target/RelayState information: "target" .

See Also:

Constant Field Values

TIME_PARAM

@Nonnull
@NotEmpty
public static final String TIME_PARAM

Name of the query parameter carrying the current time at the service provider: "time" .

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

bindingDescriptor

@Nullable
private BindingDescriptor bindingDescriptor

Optional BindingDescriptor to inject into SAMLBindingContext created.

protocolMessageLog

@Nonnull
private final org.slf4j.Logger protocolMessageLog

Used to log protocol messages.

idGenerator

@Nonnull
private final IdentifierGenerationStrategy idGenerator

ID generator.

Constructor Detail

BaseIdPInitiatedSSORequestMessageDecoder

public BaseIdPInitiatedSSORequestMessageDecoder()

Method Detail

getBindingDescriptor

@Nullable
public BindingDescriptor getBindingDescriptor()

Get an optional BindingDescriptor to inject into SAMLBindingContextSAMLBindingContext created.

Returns:

binding descriptor

setBindingDescriptor

public void setBindingDescriptor(@Nullable
                        BindingDescriptor descriptor)

Set an optional BindingDescriptor to inject into SAMLBindingContextSAMLBindingContext created.

Parameters:

descriptor - a binding descriptor

decode

public void decode()
            throws MessageDecodingException

Specified by:

decode in interface MessageDecoder<RequestType>

Overrides:

decode in class AbstractHttpServletRequestMessageDecoder<RequestType>

Throws:

MessageDecodingException

buildIdPInitiatedSSORequest

@Nonnull
protected IdPInitiatedSSORequest buildIdPInitiatedSSORequest()
                                                      throws MessageDecodingException

Build a new IdP-initiated request structure from the inbound HTTP request.

Returns:

the new SSO request structure

Throws:

MessageDecodingException - if the request doesn't contain an entityID

getEntityId

@Nonnull
@NotEmpty
protected String getEntityId(@Nonnull
                                  javax.servlet.http.HttpServletRequest request)
                      throws MessageDecodingException

Gets the entity ID of the service provider.

Parameters:

request - current HTTP request

Returns:

the entity ID of the service provider

Throws:

MessageDecodingException - thrown if the request does not contain a service provider entity ID

getAcsUrl

@Nullable
protected String getAcsUrl(@Nonnull
                        javax.servlet.http.HttpServletRequest request)

Gets the assertion consumer service URL for the service provider.

Parameters:

request - current HTTP request

Returns:

the assertion consumer service URL, may be null if none is given in the request

getTarget

@Nullable
protected String getTarget(@Nonnull
                        javax.servlet.http.HttpServletRequest request)

Gets the opaque relay state sent by the service provider.

Parameters:

request - current HTTP request

Returns:

the relay state, or null if the service provider did not send one

getTime

@Nullable
protected Long getTime(@Nonnull
                    javax.servlet.http.HttpServletRequest request)
                throws MessageDecodingException

Gets the current time, in milliseconds since the epoch, at the SP, if set.

Parameters:

request - current HTTP request

Returns:

the time sent by the service provider, or null

Throws:

MessageDecodingException - thrown if the time parameter given by the service provider is non-numeric or a negative time

logDecodedMessage

protected void logDecodedMessage()

Log the decoded message to the protocol message logger.

getMessageID

@Nonnull
protected String getMessageID()

Construct a message ID for the request.

Returns:

the message ID to use

getMessageToLog

@Nullable
protected abstract String getMessageToLog()

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

Returns:

the string representing the protocol message for logging purposes