org.opensaml.messaging.decoder.servlet

Class BaseHttpServletRequestXMLMessageDecoder<MessageType extends XMLObject>

java.lang.Object

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

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

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

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

Type Parameters:

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

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

public abstract class BaseHttpServletRequestXMLMessageDecoder<MessageType extends XMLObject>
extends AbstractHttpServletRequestMessageDecoder<MessageType>

Base class for message decoders which decode XML messages from an HttpServletRequest.

Field Summary

Fields

Modifier and Type	Field and Description
private Logger	log Class logger.
private net.shibboleth.utilities.java.support.xml.ParserPool	parserPool Parser pool used to deserialize the message.
private Logger	protocolMessageLog Used to log protocol messages.

Constructor Summary

Constructors

Constructor and Description
BaseHttpServletRequestXMLMessageDecoder() Constructor.

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()
protected XMLObject	getMessageToLog() Get the XMLObject which will be logged as the protocol message.
net.shibboleth.utilities.java.support.xml.ParserPool	getParserPool() Gets the parser pool used to deserialize incoming messages.
protected void	logDecodedMessage() Log the decoded message to the protocol message logger.
void	setParserPool(net.shibboleth.utilities.java.support.xml.ParserPool pool) Sets the parser pool used to deserialize incoming messages.
protected XMLObject	unmarshallMessage(InputStream messageStream) Helper method that deserializes and unmarshalls the message from the given stream.
protected void	validateHttpRequest(HttpServletRequest request) Perform optional validation of the inbound HttpServletRequest.

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

getHttpServletRequest, setHttpServletRequest

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

protocolMessageLog

private Logger protocolMessageLog

Used to log protocol messages.

log

private final Logger log

Class logger.

parserPool

private net.shibboleth.utilities.java.support.xml.ParserPool parserPool

Parser pool used to deserialize the message.

Constructor Detail

BaseHttpServletRequestXMLMessageDecoder

public BaseHttpServletRequestXMLMessageDecoder()

Constructor.

Method Detail

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

Overrides:

decode in class AbstractHttpServletRequestMessageDecoder<MessageType extends XMLObject>

Throws:

MessageDecodingException - if there is a problem decoding the message context

getParserPool

@Nonnull
public net.shibboleth.utilities.java.support.xml.ParserPool getParserPool()

Gets the parser pool used to deserialize incoming messages.

Returns:

parser pool used to deserialize incoming messages

setParserPool

public void setParserPool(@Nonnull
                 net.shibboleth.utilities.java.support.xml.ParserPool pool)

Sets the parser pool used to deserialize incoming messages.

Parameters:

pool - parser pool used to deserialize incoming messages

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractHttpServletRequestMessageDecoder<MessageType extends XMLObject>

doInitialize

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

Overrides:

doInitialize in class AbstractHttpServletRequestMessageDecoder<MessageType extends XMLObject>

Throws:

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

logDecodedMessage

protected void logDecodedMessage()

Log the decoded message to the protocol message logger.

getMessageToLog

protected XMLObject getMessageToLog()

Get the XMLObject which will be logged as the protocol message.

Returns:

the XMLObject message considered to be the protocol message for logging purposes

unmarshallMessage

protected XMLObject unmarshallMessage(InputStream messageStream)
                               throws MessageDecodingException

Helper method that deserializes and unmarshalls the message from the given stream.

Parameters:

messageStream - input stream containing the message

Returns:

the inbound message

Throws:

MessageDecodingException - thrown if there is a problem deserializing and unmarshalling the message

validateHttpRequest

protected void validateHttpRequest(HttpServletRequest request)
                            throws MessageDecodingException

Perform optional validation of the inbound HttpServletRequest.

This method is called before the main MessageDecoder.decode() logic}.

The default behavior is a no-op. Subclasses may override with specific constraints.

Parameters:

request - the HTTP request being validate

Throws:

MessageDecodingException - if request is not considered valid