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 NonnullSupplier<javax.servlet.http.HttpServletResponse>	httpServletResponseSupplier	Supplier for the Current HTTP servlet response, if available.
private final org.slf4j.Logger	log	Logger.

Constructor Summary

Constructors

Constructor	Description
AbstractHttpServletResponseMessageEncoder()

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()
javax.servlet.http.HttpServletResponse	getHttpServletResponse()	Get the current Http Servlet response if available.
NonnullSupplier<javax.servlet.http.HttpServletResponse>	getHttpServletResponseSupplier()	Get the supplier for the current HTTP response if available.
void	setHttpServletResponse(javax.servlet.http.HttpServletResponse response)	Deprecated, for removal: This API element is subject to removal in a future version.
void	setHttpServletResponseSupplier(NonnullSupplier<javax.servlet.http.HttpServletResponse> supplier)	Set the supplier for the HTTP servlet response on which to operate.

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

doDestroy, 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

log

private final org.slf4j.Logger log

Logger.

httpServletResponseSupplier

@Nullable
private NonnullSupplier<javax.servlet.http.HttpServletResponse> httpServletResponseSupplier

Supplier for the Current HTTP servlet response, if available.

Constructor Details

AbstractHttpServletResponseMessageEncoder

public AbstractHttpServletResponseMessageEncoder()

Method Details

getHttpServletResponse

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

Get the current Http Servlet response if available.

Specified by:

getHttpServletResponse in interface HttpServletResponseMessageEncoder

Returns:

current Http Servlet response or null

setHttpServletResponseSupplier

public void setHttpServletResponseSupplier(@Nullable
 NonnullSupplier<javax.servlet.http.HttpServletResponse> supplier)

Set the supplier for the HTTP servlet response on which to operate.

Specified by:

setHttpServletResponseSupplier in interface HttpServletResponseMessageEncoder

Parameters:

supplier - the supplier for the HTTP servlet response

getHttpServletResponseSupplier

@Nullable
public NonnullSupplier<javax.servlet.http.HttpServletResponse> getHttpServletResponseSupplier()

Get the supplier for the current HTTP response if available.

Returns:

the supplier for the current HTTP response or null

setHttpServletResponse

@Deprecated(since="4.3",
            forRemoval=true)
public void setHttpServletResponse(@Nullable
 javax.servlet.http.HttpServletResponse response)

Deprecated, for removal: This API element is subject to removal in a future version.

Set the Http servlet response on which to operate.

Specified by:

setHttpServletResponse in interface HttpServletResponseMessageEncoder

Parameters:

response - the HTTP servlet response

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractMessageEncoder

Throws:

ComponentInitializationException