Package com.adaptris.core.http.client.net

Class MetadataRequestHeaders

java.lang.Object

com.adaptris.core.http.client.net.MetadataRequestHeaders

All Implemented Interfaces:

RequestHeaderProvider<java.net.HttpURLConnection>

public class MetadataRequestHeaders
extends java.lang.Object
implements RequestHeaderProvider<java.net.HttpURLConnection>

Implementation of RequestHeaderProvider that applies AdaptrisMessage metadata as headers to a HttpURLConnection.

In the adapter configuration file this class is aliased as http-metadata-request-headers which is the preferred alternative to the fully qualified classname when building your configuration.

Field Summary

Fields

Modifier and Type	Field	Description
protected org.slf4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
MetadataRequestHeaders()
MetadataRequestHeaders(MetadataFilter mf)

Method Summary

Modifier and Type	Method	Description
java.net.HttpURLConnection	addHeaders(AdaptrisMessage msg, java.net.HttpURLConnection target)	Apply any additional headers required.
MetadataFilter	getFilter()
java.lang.Boolean	getUnfold()
void	setFilter(MetadataFilter mf)	Set the filter to be applied to metadata before adding as request properties.
void	setUnfold(java.lang.Boolean b)	Unfold headers onto a single line.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected transient org.slf4j.Logger log

Constructor Detail

MetadataRequestHeaders

public MetadataRequestHeaders()

MetadataRequestHeaders

public MetadataRequestHeaders(MetadataFilter mf)

Method Detail

addHeaders

public java.net.HttpURLConnection addHeaders(AdaptrisMessage msg,
                                             java.net.HttpURLConnection target)

Description copied from interface: RequestHeaderProvider

Apply any additional headers required.

Specified by:

addHeaders in interface RequestHeaderProvider<java.net.HttpURLConnection>

Parameters:

msg - the AdaptrisMessage to source the headers from

target - the target object to configure

Returns:

the modified target object

getFilter

public MetadataFilter getFilter()

setFilter

public void setFilter(MetadataFilter mf)

Set the filter to be applied to metadata before adding as request properties.

Parameters:

mf - the filter.

getUnfold

public java.lang.Boolean getUnfold()

setUnfold

public void setUnfold(java.lang.Boolean b)

Unfold headers onto a single line.

RFC7230 deprecates the folding of headers onto multiple lines; so HTTP headers are expected to be single line. This param allows you to enforce that unfolding metadata values happens before writing them as request properties.

Parameters:

b - true to unfold values (default is false to preserve legacy behaviour).