Package net.shibboleth.idp.admin.impl

Class DumpConfigRequestDecoder

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.messaging.decoder.AbstractMessageDecoder

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

net.shibboleth.idp.admin.impl.DumpConfigRequestDecoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder, HttpServletRequestMessageDecoder

public class DumpConfigRequestDecoder
extends AbstractHttpServletRequestMessageDecoder

Decodes an incoming configuration reporting message.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CAS_PARAM	Name of the query parameter for the CAS protocol: "cas" .
static final String	OIDC_PARAM	Name of the query parameter for the OIDC protocol: "oidc" .
static final String	PROFILE_PARAM	Name of the query parameter carrying the profile: "profile" .
static final String	PROTOCOL_PARAM	Name of the query parameter carrying the protocol: "protocol" .
static final String	REQUESTER_ID_PARAM	Name of the query parameter carrying the requester: "requester" .
static final String	SAML1_PARAM	Name of the query parameter for the SAML 1 protocol: "saml1" .
static final String	SAML2_PARAM	Name of the query parameter for the SAML 2 protocol: "saml2" .

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

BASE_PROTOCOL_MESSAGE_LOGGER_CATEGORY

Constructor Summary

Constructors

Constructor	Description
DumpConfigRequestDecoder()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doDecode()
protected String	getProfileId(HttpServletRequest request)	Get the profile ID.
protected String	getProtocolId(HttpServletRequest request)	Get the protocol string used for metadata access.
protected String	getRequesterId(HttpServletRequest request)	Get the ID of the requester.

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

doInitialize, getHttpServletRequest, getHttpServletRequestSupplier, setHttpServletRequestSupplier

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

decode, getMessageContext, getMessageToLog, getProtocolMessageLogger, getProtocolMessageLoggerSubCategory, logDecodedMessage, serializeMessageForLogging, setMessageContext, setProtocolMessageLoggerSubCategory

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.DestructableComponent

destroy, isDestroyed

Methods inherited from interface net.shibboleth.shared.component.InitializableComponent

initialize, isInitialized

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

decode, getMessageContext

Field Details

PROFILE_PARAM

@Nonnull
@NotEmpty
public static final String PROFILE_PARAM

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

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

OIDC_PARAM

@Nonnull
@NotEmpty
public static final String OIDC_PARAM

Name of the query parameter for the OIDC protocol: "oidc" .

See Also:

• Constant Field Values

REQUESTER_ID_PARAM

@Nonnull
@NotEmpty
public static final String REQUESTER_ID_PARAM

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

See Also:

• Constant Field Values

Constructor Details

DumpConfigRequestDecoder

public DumpConfigRequestDecoder()

Constructor.

Method Details

doDecode

protected void doDecode()
                 throws MessageDecodingException

Specified by:

doDecode in class AbstractMessageDecoder

Throws:

MessageDecodingException

getProfileId

@Nonnull
@NotEmpty
protected String getProfileId(@Nonnull
 HttpServletRequest request)
                       throws MessageDecodingException

Get the profile ID.

Parameters:

request - current HTTP request

Returns:

the profile ID

Throws:

MessageDecodingException - thrown if the request does not contain a profile ID

getRequesterId

@Nonnull
@NotEmpty
protected String getRequesterId(@Nonnull
 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

getProtocolId

@Nonnull
@NotEmpty
protected String getProtocolId(@Nonnull
 HttpServletRequest request)
                        throws MessageDecodingException

Get the protocol string used for metadata access.

Parameters:

request - current HTTP request

Returns:

the protocol

Throws:

MessageDecodingException - if unable to determine the protocol