Package org.opensaml.messaging.encoder.servlet

Class AbstractHttpServletResponseMessageEncoder

java.lang.Object

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

org.opensaml.messaging.encoder.AbstractMessageEncoder

org.opensaml.messaging.encoder.servlet.AbstractHttpServletResponseMessageEncoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, MessageEncoder, HttpServletResponseMessageEncoder

Direct Known Subclasses:

BaseHttpServletResponseXMLMessageEncoder

public abstract class AbstractHttpServletResponseMessageEncoder
extends AbstractMessageEncoder
implements HttpServletResponseMessageEncoder

Abstract implementation of HttpServletResponseMessageEncoder.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
AbstractHttpServletResponseMessageEncoder()

Method Summary

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

encode, prepareContext, setMessageContext

Field Details

response

@Nullable
private javax.servlet.http.HttpServletResponse response

The HTTP servlet response.

Constructor Details

AbstractHttpServletResponseMessageEncoder

public AbstractHttpServletResponseMessageEncoder()

Method Details

getHttpServletResponse

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

Get the HTTP servlet response on which to operate.

Specified by:

getHttpServletResponse in interface HttpServletResponseMessageEncoder

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

Parameters:

servletResponse - the HTTP servlet response

doDestroy

protected void doDestroy()

Overrides:

doDestroy in class AbstractMessageEncoder

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractMessageEncoder

Throws:

ComponentInitializationException