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:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, net.shibboleth.utilities.java.support.component.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 javax.servlet.http.HttpServletRequest	request	The HTTP servlet request.

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	doDestroy()
protected void	doInitialize()
javax.servlet.http.HttpServletRequest	getHttpServletRequest()	Get the HTTP servlet request on which to operate.
void	setHttpServletRequest(javax.servlet.http.HttpServletRequest servletRequest)	Set the HTTP servlet request on which to operate.

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

request

@Nullable
private javax.servlet.http.HttpServletRequest request

The HTTP servlet request.

Constructor Detail

AbstractHttpServletRequestMessageDecoder

public AbstractHttpServletRequestMessageDecoder()

Method Detail

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

setHttpServletRequest

public void setHttpServletRequest(@Nullable
                                  javax.servlet.http.HttpServletRequest servletRequest)

Set the HTTP servlet request on which to operate.

Specified by:

setHttpServletRequest in interface HttpServletRequestMessageDecoder

Parameters:

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

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractMessageDecoder

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException