org.opensaml.messaging.encoder.servlet

Interface HttpServletResponseMessageEncoder<MessageType>

Type Parameters:

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

All Superinterfaces:

Component, DestructableComponent, InitializableComponent, MessageEncoder<MessageType>

All Known Implementing Classes:

AbstractHttpServletResponseMessageEncoder, BaseHttpServletResponseXMLMessageEncoder

public interface HttpServletResponseMessageEncoder<MessageType>
extends MessageEncoder<MessageType>

A specialization of MessageEncoder that operates on a sink message data type of HttpServletResponse.

Method Summary

Modifier and Type	Method and Description
HttpServletResponse	getHttpServletResponse() Get the HTTP servlet response on which to operate.
void	setHttpServletResponse(HttpServletResponse response) Set the HTTP servlet response on which to operate.

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

Method Detail

getHttpServletResponse

@Nullable
HttpServletResponse getHttpServletResponse()

Get the HTTP servlet response on which to operate.

Returns:

the HTTP servlet response

setHttpServletResponse

void setHttpServletResponse(@Nullable
                            HttpServletResponse response)

Set the HTTP servlet response on which to operate.

Parameters:

response - the HTTP servlet response