Package org.opensaml.messaging.decoder.servlet

Class AbstractHttpServletRequestMessageDecoder

java.lang.Object

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

org.opensaml.messaging.decoder.AbstractMessageDecoder

org.opensaml.messaging.decoder.servlet.AbstractHttpServletRequestMessageDecoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageDecoder, HttpServletRequestMessageDecoder

Direct Known Subclasses:

BaseHttpServletRequestXMLMessageDecoder

public abstract class AbstractHttpServletRequestMessageDecoder
extends AbstractMessageDecoder
implements HttpServletRequestMessageDecoder

Abstract implementation of HttpServletRequestMessageDecoder.

Field Summary

Fields

Modifier and Type	Field	Description
private NonnullSupplier<javax.servlet.http.HttpServletRequest>	httpServletRequestSupplier	Current HTTP request, if available.
private final org.slf4j.Logger	log	Logger.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpServletRequestMessageDecoder()

Method Summary

Modifier and Type	Method	Description
void	decode()	Decode message data from the source and store it so that it may be retrieved via MessageDecoder.getMessageContext().
protected void	doInitialize()
javax.servlet.http.HttpServletRequest	getHttpServletRequest()	Get the HTTP servlet request on which to operate.
NonnullSupplier<javax.servlet.http.HttpServletRequest>	getHttpServletRequestSupplier()	Get the supplier for HTTP request if available.
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest request)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setHttpServletRequestSupplier(NonnullSupplier<javax.servlet.http.HttpServletRequest> requestSupplier)	Set the supplier for the HTTP servlet request on which to operate.

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

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

log

private final org.slf4j.Logger log

Logger.

httpServletRequestSupplier

@Nullable
private NonnullSupplier<javax.servlet.http.HttpServletRequest> httpServletRequestSupplier

Current HTTP request, if available.

Constructor Details

AbstractHttpServletRequestMessageDecoder

public AbstractHttpServletRequestMessageDecoder()

Method Details

getHttpServletRequest

@Nullable
public javax.servlet.http.HttpServletRequest getHttpServletRequest()

Get the HTTP servlet request on which to operate.

Specified by:

getHttpServletRequest in interface HttpServletRequestMessageDecoder

Returns:

the HTTP servlet request

getHttpServletRequestSupplier

@Nullable
public NonnullSupplier<javax.servlet.http.HttpServletRequest> getHttpServletRequestSupplier()

Get the supplier for HTTP request if available.

Returns:

current HTTP request

setHttpServletRequest

@Deprecated(since="4.3",
            forRemoval=true)
public void setHttpServletRequest(@Nullable
 javax.servlet.http.HttpServletRequest request)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the HTTP servlet request on which to operate.

Specified by:

setHttpServletRequest in interface HttpServletRequestMessageDecoder

Parameters:

request - the HTTP servlet request

setHttpServletRequestSupplier

public void setHttpServletRequestSupplier(@Nullable
 NonnullSupplier<javax.servlet.http.HttpServletRequest> requestSupplier)

Set the supplier for the HTTP servlet request on which to operate.

Specified by:

setHttpServletRequestSupplier in interface HttpServletRequestMessageDecoder

Parameters:

requestSupplier - the HTTP servlet request

decode

public void decode()
            throws MessageDecodingException

Decode message data from the source and store it so that it may be retrieved via MessageDecoder.getMessageContext().

Specified by:

decode in interface MessageDecoder

Overrides:

decode in class AbstractMessageDecoder

Throws:

MessageDecodingException - if there is a problem decoding the message context

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException