org.opensaml.messaging.encoder.servlet

Class AbstractHttpServletResponseMessageEncoder<MessageType>

java.lang.Object

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

org.opensaml.messaging.encoder.AbstractMessageEncoder<MessageType>

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder<MessageType>

Type Parameters:

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

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageEncoder<MessageType>, HttpServletResponseMessageEncoder<MessageType>

Direct Known Subclasses:

BaseHttpServletResponseXMLMessageEncoder

public abstract class AbstractHttpServletResponseMessageEncoder<MessageType>
extends AbstractMessageEncoder<MessageType>
implements HttpServletResponseMessageEncoder<MessageType>

Abstract implementation of HttpServletResponseMessageEncoder.

Field Summary

Fields

Modifier and Type	Field and Description
private javax.servlet.http.HttpServletResponse	response The HTTP servlet response.

Constructor Summary

Constructors

Constructor and Description
AbstractHttpServletResponseMessageEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doDestroy()
protected void	doInitialize()
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Get the HTTP servlet response on which to operate.
void	setHttpServletResponse(javax.servlet.http.HttpServletResponse servletResponse) Set the HTTP servlet response on which to operate.

Methods inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder

doEncode, encode, getMessageContext, prepareContext, 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.encoder.MessageEncoder

encode, prepareContext, setMessageContext

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

response

private javax.servlet.http.HttpServletResponse response

The HTTP servlet response.

Constructor Detail

AbstractHttpServletResponseMessageEncoder

public AbstractHttpServletResponseMessageEncoder()

Method Detail

getHttpServletResponse

@Nullable
public javax.servlet.http.HttpServletResponse getHttpServletResponse()

Get the HTTP servlet response on which to operate.

Specified by:

getHttpServletResponse in interface HttpServletResponseMessageEncoder<MessageType>

Returns:

the HTTP servlet response

setHttpServletResponse

public void setHttpServletResponse(@Nullable
                          javax.servlet.http.HttpServletResponse servletResponse)

Set the HTTP servlet response on which to operate.

Specified by:

setHttpServletResponse in interface HttpServletResponseMessageEncoder<MessageType>

Parameters:

servletResponse - the HTTP servlet response

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractMessageEncoder<MessageType>

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractMessageEncoder<MessageType>

Throws:

ComponentInitializationException