DefaultHttpHeaderMapper (Spring Integration 4.3.24.RELEASE API)

java.lang.Object
- org.springframework.integration.http.support.DefaultHttpHeaderMapper

All Implemented Interfaces:

Aware, BeanFactoryAware, InitializingBean, HeaderMapper<HttpHeaders>
```
public class DefaultHttpHeaderMapper
extends Object
implements HeaderMapper<HttpHeaders>, BeanFactoryAware, InitializingBean
```
Default HeaderMapper implementation for HTTP.

Since:

2.0

Author:

Mark Fisher, Jeremy Grelle, Oleg Zhurakousky, Gunnar Hillert, Gary Russell, Artem Bilan

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCEPT`
`static String`	`ACCEPT_CHARSET`
`static String`	`ACCEPT_ENCODING`
`static String`	`ACCEPT_LANGUAGE`
`static String`	`ACCEPT_RANGES`
`static String`	`AGE`
`static String`	`ALLOW`
`static String`	`AUTHORIZATION`
`static String`	`CACHE_CONTROL`
`static String`	`CONNECTION`
`static String`	`CONTENT_DISPOSITION`
`static String`	`CONTENT_ENCODING`
`static String`	`CONTENT_LANGUAGE`
`static String`	`CONTENT_LENGTH`
`static String`	`CONTENT_LOCATION`
`static String`	`CONTENT_MD5`
`static String`	`CONTENT_RANGE`
`static String`	`CONTENT_TYPE`
`static String`	`COOKIE`
`static String`	`DATE`
`protected static String[]`	`DATE_FORMATS`
`static String`	`ETAG`
`static String`	`EXPECT`
`static String`	`EXPIRES`
`static String`	`FROM`
`static String`	`HOST`
`static String`	`HTTP_REQUEST_HEADER_NAME_PATTERN`
`static String`	`HTTP_RESPONSE_HEADER_NAME_PATTERN`
`static String`	`IF_MATCH`
`static String`	`IF_MODIFIED_SINCE`
`static String`	`IF_NONE_MATCH`
`static String`	`IF_RANGE`
`static String`	`IF_UNMODIFIED_SINCE`
`static String`	`LAST_MODIFIED`
`static String`	`LOCATION`
`protected Log`	`logger`
`static String`	`MAX_FORWARDS`
`static String`	`PRAGMA`
`static String`	`PROXY_AUTHENTICATE`
`static String`	`PROXY_AUTHORIZATION`
`static String`	`RANGE`
`static String`	`REFERER`
`static String`	`REFRESH`
`static String`	`RETRY_AFTER`
`static String`	`SERVER`
`static String`	`SET_COOKIE`
`static String`	`TE`
`static String`	`TRAILER`
`static String`	`TRANSFER_ENCODING`
`static String`	`UPGRADE`
`static String`	`USER_AGENT`
`static String`	`VARY`
`static String`	`VIA`
`static String`	`WARNING`
`static String`	`WWW_AUTHENTICATE`

Constructor Summary

Constructors
Constructor and Description

DefaultHttpHeaderMapper()

Constructors
Constructor and Description
`DefaultHttpHeaderMapper()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterPropertiesSet()`
`protected boolean`	`containsElementIgnoreCase(String[] headerNames, String name)`
`protected String`	`convertToString(Object value)`
`protected String`	`formatDate(long date)`
`void`	`fromHeaders(MessageHeaders headers, HttpHeaders target)` Map from the integration MessageHeaders to an HttpHeaders instance.
`protected BeanFactory`	`getBeanFactory()`
`protected long`	`getFirstDate(String headerValue, String headerName)`
`protected Object`	`getHttpHeader(HttpHeaders source, String name)`
`static DefaultHttpHeaderMapper`	`inboundMapper()` Factory method for creating a basic inbound mapper instance.
`static DefaultHttpHeaderMapper`	`outboundMapper()` Factory method for creating a basic outbound mapper instance.
`void`	`setBeanFactory(BeanFactory beanFactory)`
`void`	`setExcludedInboundStandardResponseHeaderNames(String[] excludedInboundStandardResponseHeaderNames)` Provide header names from the list of standard headers that should be suppressed when mapping inbound endpoint response headers.
`void`	`setExcludedOutboundStandardRequestHeaderNames(String[] excludedOutboundStandardRequestHeaderNames)` Provide header names from the list of standard headers that should be suppressed when mapping outbound endpoint request headers.
`void`	`setInboundHeaderNames(String[] inboundHeaderNames)` Provide the header names that should be mapped from an HTTP request (for inbound adapters) or HTTP response (for outbound adapters) to a Spring Integration Message's headers.
`void`	`setOutboundHeaderNames(String[] outboundHeaderNames)` Provide the header names that should be mapped to an HTTP request (for outbound adapters) or HTTP response (for inbound adapters) from a Spring Integration Message's headers.
`protected static void`	`setupDefaultInboundMapper(DefaultHttpHeaderMapper mapper)` Subclasses can call this from a static inboundMapper() method to set up standard header mappings for an inbound mapper.
`protected static void`	`setupDefaultOutboundMapper(DefaultHttpHeaderMapper mapper)` Subclasses can call this from a static outboundMapper() method to set up standard header mappings for an outbound mapper.
`void`	`setUserDefinedHeaderPrefix(String userDefinedHeaderPrefix)` Sets the prefix to use with user-defined (non-standard) headers.
`protected boolean`	`shouldMapInboundHeader(String headerName)`
`Map<String,Object>`	`toHeaders(HttpHeaders source)` Map from an HttpHeaders instance to integration MessageHeaders.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected final Log logger
```
  - ACCEPT
```
public static final String ACCEPT
```
    See Also:
    
    Constant Field Values
  - ACCEPT_CHARSET
```
public static final String ACCEPT_CHARSET
```
    See Also:
    
    Constant Field Values
  - ACCEPT_ENCODING
```
public static final String ACCEPT_ENCODING
```
    See Also:
    
    Constant Field Values
  - ACCEPT_LANGUAGE
```
public static final String ACCEPT_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - ACCEPT_RANGES
```
public static final String ACCEPT_RANGES
```
    See Also:
    
    Constant Field Values
  - AGE
```
public static final String AGE
```
    See Also:
    
    Constant Field Values
  - ALLOW
```
public static final String ALLOW
```
    See Also:
    
    Constant Field Values
  - AUTHORIZATION
```
public static final String AUTHORIZATION
```
    See Also:
    
    Constant Field Values
  - CACHE_CONTROL
```
public static final String CACHE_CONTROL
```
    See Also:
    
    Constant Field Values
  - CONNECTION
```
public static final String CONNECTION
```
    See Also:
    
    Constant Field Values
  - CONTENT_ENCODING
```
public static final String CONTENT_ENCODING
```
    See Also:
    
    Constant Field Values
  - CONTENT_LANGUAGE
```
public static final String CONTENT_LANGUAGE
```
    See Also:
    
    Constant Field Values
  - CONTENT_LENGTH
```
public static final String CONTENT_LENGTH
```
    See Also:
    
    Constant Field Values
  - CONTENT_LOCATION
```
public static final String CONTENT_LOCATION
```
    See Also:
    
    Constant Field Values
  - CONTENT_MD5
```
public static final String CONTENT_MD5
```
    See Also:
    
    Constant Field Values
  - CONTENT_RANGE
```
public static final String CONTENT_RANGE
```
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE
```
public static final String CONTENT_TYPE
```
    See Also:
    
    Constant Field Values
  - CONTENT_DISPOSITION
```
public static final String CONTENT_DISPOSITION
```
    See Also:
    
    Constant Field Values
  - COOKIE
```
public static final String COOKIE
```
    See Also:
    
    Constant Field Values
  - DATE
```
public static final String DATE
```
    See Also:
    
    Constant Field Values
  - ETAG
```
public static final String ETAG
```
    See Also:
    
    Constant Field Values
  - EXPECT
```
public static final String EXPECT
```
    See Also:
    
    Constant Field Values
  - EXPIRES
```
public static final String EXPIRES
```
    See Also:
    
    Constant Field Values
  - FROM
```
public static final String FROM
```
    See Also:
    
    Constant Field Values
  - HOST
```
public static final String HOST
```
    See Also:
    
    Constant Field Values
  - IF_MATCH
```
public static final String IF_MATCH
```
    See Also:
    
    Constant Field Values
  - IF_MODIFIED_SINCE
```
public static final String IF_MODIFIED_SINCE
```
    See Also:
    
    Constant Field Values
  - IF_NONE_MATCH
```
public static final String IF_NONE_MATCH
```
    See Also:
    
    Constant Field Values
  - IF_RANGE
```
public static final String IF_RANGE
```
    See Also:
    
    Constant Field Values
  - IF_UNMODIFIED_SINCE
```
public static final String IF_UNMODIFIED_SINCE
```
    See Also:
    
    Constant Field Values
  - LAST_MODIFIED
```
public static final String LAST_MODIFIED
```
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final String LOCATION
```
    See Also:
    
    Constant Field Values
  - MAX_FORWARDS
```
public static final String MAX_FORWARDS
```
    See Also:
    
    Constant Field Values
  - PRAGMA
```
public static final String PRAGMA
```
    See Also:
    
    Constant Field Values
  - PROXY_AUTHENTICATE
```
public static final String PROXY_AUTHENTICATE
```
    See Also:
    
    Constant Field Values
  - PROXY_AUTHORIZATION
```
public static final String PROXY_AUTHORIZATION
```
    See Also:
    
    Constant Field Values
  - RANGE
```
public static final String RANGE
```
    See Also:
    
    Constant Field Values
  - REFERER
```
public static final String REFERER
```
    See Also:
    
    Constant Field Values
  - REFRESH
```
public static final String REFRESH
```
    See Also:
    
    Constant Field Values
  - RETRY_AFTER
```
public static final String RETRY_AFTER
```
    See Also:
    
    Constant Field Values
  - SERVER
```
public static final String SERVER
```
    See Also:
    
    Constant Field Values
  - SET_COOKIE
```
public static final String SET_COOKIE
```
    See Also:
    
    Constant Field Values
  - TE
```
public static final String TE
```
    See Also:
    
    Constant Field Values
  - TRAILER
```
public static final String TRAILER
```
    See Also:
    
    Constant Field Values
  - UPGRADE
```
public static final String UPGRADE
```
    See Also:
    
    Constant Field Values
  - USER_AGENT
```
public static final String USER_AGENT
```
    See Also:
    
    Constant Field Values
  - VARY
```
public static final String VARY
```
    See Also:
    
    Constant Field Values
  - VIA
```
public static final String VIA
```
    See Also:
    
    Constant Field Values
  - WARNING
```
public static final String WARNING
```
    See Also:
    
    Constant Field Values
  - WWW_AUTHENTICATE
```
public static final String WWW_AUTHENTICATE
```
    See Also:
    
    Constant Field Values
  - TRANSFER_ENCODING
```
public static final String TRANSFER_ENCODING
```
    See Also:
    
    Constant Field Values
  - HTTP_REQUEST_HEADER_NAME_PATTERN
```
public static final String HTTP_REQUEST_HEADER_NAME_PATTERN
```
    See Also:
    
    Constant Field Values
  - HTTP_RESPONSE_HEADER_NAME_PATTERN
```
public static final String HTTP_RESPONSE_HEADER_NAME_PATTERN
```
    See Also:
    
    Constant Field Values
  - DATE_FORMATS
```
protected static final String[] DATE_FORMATS
```
- Constructor Detail
  - DefaultHttpHeaderMapper
```
public DefaultHttpHeaderMapper()
```
- Method Detail
  - setBeanFactory
```
public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException
```
    Specified by:
    
    setBeanFactory in interface BeanFactoryAware
    
    Throws:
    
    BeansException
  - getBeanFactory
```
protected BeanFactory getBeanFactory()
```
  - setOutboundHeaderNames
```
public void setOutboundHeaderNames(String[] outboundHeaderNames)
```
    Provide the header names that should be mapped to an HTTP request (for outbound adapters) or HTTP response (for inbound adapters) from a Spring Integration Message's headers. The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched.
    Any non-standard headers will be prefixed with the value specified by setUserDefinedHeaderPrefix(String). The default is 'X-'.
    
    Parameters:
    
    outboundHeaderNames - The outbound header names.
  - setInboundHeaderNames
```
public void setInboundHeaderNames(String[] inboundHeaderNames)
```
    Provide the header names that should be mapped from an HTTP request (for inbound adapters) or HTTP response (for outbound adapters) to a Spring Integration Message's headers. The values can also contain simple wildcard patterns (e.g. "foo*" or "*foo") to be matched.
    This will match the header name directly or, for non-standard HTTP headers, it will match the header name prefixed with the value specified by setUserDefinedHeaderPrefix(String). The default is 'X-'.
    
    Parameters:
    
    inboundHeaderNames - The inbound header names.
  - setExcludedOutboundStandardRequestHeaderNames
```
public void setExcludedOutboundStandardRequestHeaderNames(String[] excludedOutboundStandardRequestHeaderNames)
```
    Provide header names from the list of standard headers that should be suppressed when mapping outbound endpoint request headers.
    
    Parameters:
    
    excludedOutboundStandardRequestHeaderNames - the excludedStandardRequestHeaderNames to set
  - setExcludedInboundStandardResponseHeaderNames
```
public void setExcludedInboundStandardResponseHeaderNames(String[] excludedInboundStandardResponseHeaderNames)
```
    Provide header names from the list of standard headers that should be suppressed when mapping inbound endpoint response headers.
    
    Parameters:
    
    excludedInboundStandardResponseHeaderNames - the excludedStandardResponseHeaderNames to set
  - setUserDefinedHeaderPrefix
```
public void setUserDefinedHeaderPrefix(String userDefinedHeaderPrefix)
```
    Sets the prefix to use with user-defined (non-standard) headers. Default is 'X-'.
    
    Parameters:
    
    userDefinedHeaderPrefix - The user defined header prefix.
  - fromHeaders
```
public void fromHeaders(MessageHeaders headers,
                        HttpHeaders target)
```
    Map from the integration MessageHeaders to an HttpHeaders instance. Depending on which type of adapter is using this mapper, the HttpHeaders might be for an HTTP request (outbound adapter) or for an HTTP response (inbound adapter).
    
    Specified by:
    
    fromHeaders in interface HeaderMapper<HttpHeaders>
  - toHeaders
```
public Map<String,Object> toHeaders(HttpHeaders source)
```
    Map from an HttpHeaders instance to integration MessageHeaders. Depending on which type of adapter is using this mapper, the HttpHeaders might be from an HTTP request (inbound adapter) or from an HTTP response (outbound adapter).
    
    Specified by:
    
    toHeaders in interface HeaderMapper<HttpHeaders>
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws Exception
```
    Specified by:
    
    afterPropertiesSet in interface InitializingBean
    
    Throws:
    
    Exception
  - containsElementIgnoreCase
```
protected final boolean containsElementIgnoreCase(String[] headerNames,
                                                  String name)
```
  - shouldMapInboundHeader
```
protected final boolean shouldMapInboundHeader(String headerName)
```
  - getHttpHeader
```
protected Object getHttpHeader(HttpHeaders source,
                               String name)
```
  - convertToString
```
protected String convertToString(Object value)
```
  - getFirstDate
```
protected long getFirstDate(String headerValue,
                            String headerName)
```
  - formatDate
```
protected String formatDate(long date)
```
  - outboundMapper
```
public static DefaultHttpHeaderMapper outboundMapper()
```
    Factory method for creating a basic outbound mapper instance. This will map all standard HTTP request headers when sending an HTTP request, and it will map all standard HTTP response headers when receiving an HTTP response.
    
    Returns:
    
    The default outbound mapper.
  - setupDefaultOutboundMapper
```
protected static void setupDefaultOutboundMapper(DefaultHttpHeaderMapper mapper)
```
    Subclasses can call this from a static outboundMapper() method to set up standard header mappings for an outbound mapper.
    
    Parameters:
    
    mapper - the mapper.
  - inboundMapper
```
public static DefaultHttpHeaderMapper inboundMapper()
```
    Factory method for creating a basic inbound mapper instance. This will map all standard HTTP request headers when receiving an HTTP request, and it will map all standard HTTP response headers when sending an HTTP response.
    
    Returns:
    
    The default inbound mapper.
  - setupDefaultInboundMapper
```
protected static void setupDefaultInboundMapper(DefaultHttpHeaderMapper mapper)
```
    Subclasses can call this from a static inboundMapper() method to set up standard header mappings for an inbound mapper.
    
    Parameters:
    
    mapper - the mapper.

Class DefaultHttpHeaderMapper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

ACCEPT

ACCEPT_CHARSET

ACCEPT_ENCODING

ACCEPT_LANGUAGE

ACCEPT_RANGES

AGE

ALLOW

AUTHORIZATION

CACHE_CONTROL

CONNECTION

CONTENT_ENCODING

CONTENT_LANGUAGE

CONTENT_LENGTH

CONTENT_LOCATION

CONTENT_MD5

CONTENT_RANGE

CONTENT_TYPE

CONTENT_DISPOSITION

COOKIE

DATE

ETAG

EXPECT

EXPIRES

FROM

HOST

IF_MATCH

IF_MODIFIED_SINCE

IF_NONE_MATCH

IF_RANGE

IF_UNMODIFIED_SINCE

LAST_MODIFIED

LOCATION

MAX_FORWARDS

PRAGMA

PROXY_AUTHENTICATE

PROXY_AUTHORIZATION

RANGE

REFERER

REFRESH

RETRY_AFTER

SERVER

SET_COOKIE

TE

TRAILER

UPGRADE

USER_AGENT

VARY

VIA

WARNING

WWW_AUTHENTICATE

TRANSFER_ENCODING

HTTP_REQUEST_HEADER_NAME_PATTERN

HTTP_RESPONSE_HEADER_NAME_PATTERN

DATE_FORMATS

Constructor Detail

DefaultHttpHeaderMapper

Method Detail

setBeanFactory

getBeanFactory

setOutboundHeaderNames

setInboundHeaderNames

setExcludedOutboundStandardRequestHeaderNames

setExcludedInboundStandardResponseHeaderNames

setUserDefinedHeaderPrefix

fromHeaders

toHeaders

afterPropertiesSet

containsElementIgnoreCase

shouldMapInboundHeader

getHttpHeader

convertToString

getFirstDate

formatDate