net.shibboleth.idp.profile.impl

Class ResolverTestRequestDecoder

java.lang.Object

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

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

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

net.shibboleth.idp.profile.impl.ResolverTestRequestDecoder

All Implemented Interfaces:

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

public class ResolverTestRequestDecoder
extends AbstractHttpServletRequestMessageDecoder<ResolverTestRequest>

Decodes an incoming resolver test message.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACS_INDEX_PARAM Name of the query parameter carrying the ACS index: "acsIndex" .
private org.slf4j.Logger	log Class logger.
static String	PRINCIPAL_PARAM Name of the query parameter carrying the subject name: "principal" .
static String	PROTOCOL_PARAM Name of the query parameter carrying the protocol: "protocol" .
static String	REQUESTER_ID_PARAM Name of the query parameter carrying the requesterID: "requester" .
static String	SAML1_PARAM Name of the query parameter for the SAML 1 protocol: "saml1" .
static String	SAML2_PARAM Name of the query parameter for the SAML 2 protocol: "saml2" .

Constructor Summary

Constructors

Constructor and Description
ResolverTestRequestDecoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDecode()
protected Integer	getIndex(javax.servlet.http.HttpServletRequest request) Get the ACS index.
protected String	getPrincipal(javax.servlet.http.HttpServletRequest request) Get the name of the subject.
protected String	getProtocol(javax.servlet.http.HttpServletRequest request) Get the protocol.
protected String	getRequesterId(javax.servlet.http.HttpServletRequest request) Get the ID of the requester.

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

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

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

PRINCIPAL_PARAM

@Nonnull
@NotEmpty
public static final String PRINCIPAL_PARAM

Name of the query parameter carrying the subject name: "principal" .

See Also:

Constant Field Values

REQUESTER_ID_PARAM

@Nonnull
@NotEmpty
public static final String REQUESTER_ID_PARAM

Name of the query parameter carrying the requesterID: "requester" .

See Also:

Constant Field Values

ACS_INDEX_PARAM

@Nonnull
@NotEmpty
public static final String ACS_INDEX_PARAM

Name of the query parameter carrying the ACS index: "acsIndex" .

See Also:

Constant Field Values

PROTOCOL_PARAM

@Nonnull
@NotEmpty
public static final String PROTOCOL_PARAM

Name of the query parameter carrying the protocol: "protocol" .

See Also:

Constant Field Values

SAML1_PARAM

@Nonnull
@NotEmpty
public static final String SAML1_PARAM

Name of the query parameter for the SAML 1 protocol: "saml1" .

See Also:

Constant Field Values

SAML2_PARAM

@Nonnull
@NotEmpty
public static final String SAML2_PARAM

Name of the query parameter for the SAML 2 protocol: "saml2" .

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

ResolverTestRequestDecoder

public ResolverTestRequestDecoder()

Method Detail

doDecode

protected void doDecode()
                 throws MessageDecodingException

Specified by:

doDecode in class AbstractMessageDecoder<ResolverTestRequest>

Throws:

MessageDecodingException

getPrincipal

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

Get the name of the subject.

Parameters:

request - current HTTP request

Returns:

the name of the subject

Throws:

MessageDecodingException - thrown if the request does not contain a subject name

getRequesterId

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

Get the ID of the requester.

Parameters:

request - current HTTP request

Returns:

the ID of the requester

Throws:

MessageDecodingException - thrown if the request does not contain a requester name

getIndex

@Nullable
protected Integer getIndex(@Nonnull
                        javax.servlet.http.HttpServletRequest request)

Get the ACS index.

Parameters:

request - current HTTP request

Returns:

the ACS index, or null

getProtocol

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

Get the protocol.

Parameters:

request - current HTTP request

Returns:

the protocol, or null