org.opensaml.messaging.decoder.servlet

Class AbstractHttpServletRequestMessageDecoder<MessageType>

java.lang.Object

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

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

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

Type Parameters:

MessageType - the message type of the message context on which to operate

All Implemented Interfaces:

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

Direct Known Subclasses:

BaseHttpServletRequestXMLMessageDecoder

public abstract class AbstractHttpServletRequestMessageDecoder<MessageType>
extends AbstractMessageDecoder<MessageType>
implements HttpServletRequestMessageDecoder<MessageType>

Abstract implementation of HttpServletRequestMessageDecoder.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.servlet.http.HttpServletRequest	request The HTTP servlet request.

Constructor Summary

Constructors

Constructor and Description
AbstractHttpServletRequestMessageDecoder()

Method Summary

Methods

Modifier and Type	Method and 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 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

request

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

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

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

Overrides:

decode in class AbstractMessageDecoder<MessageType>

Throws:

MessageDecodingException - if there is a problem decoding the message context

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractMessageDecoder<MessageType>

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException