HttpClientRequestMessageEncoder (OpenSAML :: Messaging API 4.0.0-beta2 API)

All Superinterfaces:

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

All Known Implementing Classes:

AbstractHttpClientRequestMessageEncoder, BaseHttpClientRequestXMLMessageEncoder
```
public interface HttpClientRequestMessageEncoder
extends MessageEncoder
```
A specialization of MessageEncoder that operates on a sink message data type of HttpRequest.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`org.apache.http.HttpRequest`	`getHttpRequest()`	Get the HTTP client request on which to operate.
`void`	`setHttpRequest(org.apache.http.HttpRequest request)`	Set the HTTP client request 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
  - getHttpRequest
```
@Nullable
org.apache.http.HttpRequest getHttpRequest()
```
    Get the HTTP client request on which to operate.
    
    Returns:
    
    the HTTP client request
  - setHttpRequest
```
void setHttpRequest(@Nullable
                    org.apache.http.HttpRequest request)
```
    Set the HTTP client request on which to operate.
    
    Parameters:
    
    request - the HTTP client request