HttpServletResponseMessageEncoder (OpenSAML :: Messaging API 4.3.0 API)

All Superinterfaces:

Component, DestructableComponent, InitializableComponent, MessageEncoder

All Known Implementing Classes:

AbstractHttpServletResponseMessageEncoder, BaseHttpServletResponseXMLMessageEncoder
```
public interface HttpServletResponseMessageEncoder
extends MessageEncoder
```
A specialization of MessageEncoder that operates on a sink message data type of HttpServletResponse.

Method Summary

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

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

- Method Detail
  - getHttpServletResponse
```
@Nullable
javax.servlet.http.HttpServletResponse getHttpServletResponse()
```
    Get the current Http Servlet response if available.
    
    Returns:
    
    current Http Servlet response or null
  - setHttpServletResponse
```
@Deprecated(forRemoval=true,
            since="4.3")
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.
    
    Parameters:
    
    response - the HTTP servlet response
  - setHttpServletResponseSupplier
```
default void setHttpServletResponseSupplier(@Nullable
                                            NonnullSupplier<javax.servlet.http.HttpServletResponse> responseSupplier)
```
    Set the supplier for the HTTP servlet response on which to operate.
    
    Parameters:
    
    responseSupplier - the supplier for the HTTP servlet response