AbstractHttpClientRequestMessageEncoder (OpenSAML :: Messaging API 4.1.1 API)

java.lang.Object
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
- - org.opensaml.messaging.encoder.AbstractMessageEncoder
  - - org.opensaml.messaging.encoder.httpclient.AbstractHttpClientRequestMessageEncoder

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, UnmodifiableComponent, HttpClientRequestMessageEncoder, MessageEncoder

Direct Known Subclasses:

BaseHttpClientRequestXMLMessageEncoder
```
public abstract class AbstractHttpClientRequestMessageEncoder
extends AbstractMessageEncoder
implements HttpClientRequestMessageEncoder
```
Abstract implementation of HttpServletResponseMessageEncoder.

Field Summary

Fields
Modifier and Type Field Description

private org.apache.http.HttpRequest request
The HTTP client request.

Constructor Summary

Constructors
Constructor Description

AbstractHttpClientRequestMessageEncoder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`doDestroy()`
`protected void`	`doInitialize()`
`org.apache.http.HttpRequest`	`getHttpRequest()`	Get the HTTP client request on which to operate.
`void`	`setHttpRequest(org.apache.http.HttpRequest httpRequest)`	Set the HTTP client request on which to operate.

Methods inherited from class org.opensaml.messaging.encoder.AbstractMessageEncoder
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 Detail
  - request
```
@Nullable
private org.apache.http.HttpRequest request
```
    The HTTP client request.
- Constructor Detail
  - AbstractHttpClientRequestMessageEncoder
```
public AbstractHttpClientRequestMessageEncoder()
```
- Method Detail
  - getHttpRequest
```
@Nullable
public org.apache.http.HttpRequest getHttpRequest()
```
    Get the HTTP client request on which to operate.
    
    Specified by:
    
    getHttpRequest in interface HttpClientRequestMessageEncoder
    
    Returns:
    
    the HTTP client request
  - setHttpRequest
```
public void setHttpRequest(@Nullable
                           org.apache.http.HttpRequest httpRequest)
```
    Set the HTTP client request on which to operate.
    
    Specified by:
    
    setHttpRequest in interface HttpClientRequestMessageEncoder
    
    Parameters:
    
    httpRequest - the HTTP client request
  - doDestroy
```
protected void doDestroy()
```
    Overrides:
    
    doDestroy in class AbstractMessageEncoder
  - doInitialize
```
protected void doInitialize()
                     throws ComponentInitializationException
```
    Overrides:
    
    doInitialize in class AbstractMessageEncoder
    
    Throws:
    
    ComponentInitializationException