Package net.shibboleth.idp.profile.impl

Class MetadataQueryRequestDecoder

java.lang.Object

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

org.opensaml.messaging.decoder.AbstractMessageDecoder

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

net.shibboleth.idp.profile.impl.MetadataQueryRequestDecoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder, HttpServletRequestMessageDecoder

public class MetadataQueryRequestDecoder
extends AbstractHttpServletRequestMessageDecoder

Decodes an incoming metadata query request.

Field Summary

Fields

Modifier and Type	Field	Description
static String	CAS_PARAM	Name of the query parameter for the CAS protocol: "cas" .
static String	DETECT_DUPLICATES_PARAM	Name of the query parameter carrying the detectDuplicateEntityIDs: "detectDuplicateEntityIDs" .
static String	ENTITY_ID_PARAM	Name of the query parameter carrying the entityID: "entityID" .
private org.slf4j.Logger	log	Class logger.
static String	PROTOCOL_PARAM	Name of the query parameter carrying the protocol: "protocol" .
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	Description
MetadataQueryRequestDecoder()

Method Summary

Modifier and Type	Method	Description
protected void	doDecode()
protected DetectDuplicateEntityIDs	getDetectDuplicateEntityIDs(javax.servlet.http.HttpServletRequest request)	Get the strategy for duplicate entityID detection.
protected String	getEntityID(javax.servlet.http.HttpServletRequest request)	Get the entityID parameter.
protected String	getProtocol(javax.servlet.http.HttpServletRequest request)	Get the protocol.

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

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

getMessageContext

Field Detail

ENTITY_ID_PARAM

@Nonnull
@NotEmpty
public static final String ENTITY_ID_PARAM

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

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

CAS_PARAM

@Nonnull
@NotEmpty
public static final String CAS_PARAM

Name of the query parameter for the CAS protocol: "cas" .

See Also:

Constant Field Values

DETECT_DUPLICATES_PARAM

@Nonnull
@NotEmpty
public static final String DETECT_DUPLICATES_PARAM

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

See Also:

Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

Constructor Detail

MetadataQueryRequestDecoder

public MetadataQueryRequestDecoder()

Method Detail

doDecode

protected void doDecode()
                 throws MessageDecodingException

Specified by:

doDecode in class AbstractMessageDecoder

Throws:

MessageDecodingException

getEntityID

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

Get the entityID parameter.

Parameters:

request - current HTTP request

Returns:

the entityID

Throws:

MessageDecodingException - thrown if the request does not contain an entityID

getProtocol

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

Get the protocol.

Parameters:

request - current HTTP request

Returns:

the protocol, or null

getDetectDuplicateEntityIDs

@Nullable
protected DetectDuplicateEntityIDs getDetectDuplicateEntityIDs(@Nonnull
                                                               javax.servlet.http.HttpServletRequest request)
                                                        throws MessageDecodingException

Get the strategy for duplicate entityID detection.

Parameters:

request - current HTTP request

Returns:

the strategy, or null

Throws:

MessageDecodingException - if the request request contains an invalid value for detectDuplicateEntityIDs