org.opensaml.messaging.encoder.servlet

Interface HttpServletResponseMessageEncoder<MessageType>

Type Parameters:

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

All Superinterfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, MessageEncoder<MessageType>

All Known Implementing Classes:

AbstractHttpServletResponseMessageEncoder, BaseHttpServletResponseXMLMessageEncoder, BaseSAML1MessageEncoder, BaseSAML2MessageEncoder, HTTPArtifactEncoder, HTTPArtifactEncoder, HTTPPostEncoder, HTTPPostEncoder, HTTPPostSimpleSignEncoder, HTTPRedirectDeflateEncoder, HTTPSOAP11Encoder, HTTPSOAP11Encoder, HTTPSOAP11Encoder

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
javax.servlet.http.HttpServletResponse	getHttpServletResponse() Get the HTTP servlet response on which to operate.
void	setHttpServletResponse(javax.servlet.http.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
javax.servlet.http.HttpServletResponse getHttpServletResponse()

Get the HTTP servlet response on which to operate.

Returns:

the HTTP servlet response

setHttpServletResponse

void setHttpServletResponse(@Nullable
                            javax.servlet.http.HttpServletResponse response)

Set the HTTP servlet response on which to operate.

Parameters:

response - the HTTP servlet response