org.springframework.integration.ws

Class DefaultSoapHeaderMapper

java.lang.Object

org.springframework.integration.mapping.AbstractHeaderMapper<org.springframework.ws.soap.SoapMessage>

org.springframework.integration.ws.DefaultSoapHeaderMapper

All Implemented Interfaces:

RequestReplyHeaderMapper<org.springframework.ws.soap.SoapMessage>, SoapHeaderMapper

public class DefaultSoapHeaderMapper
extends AbstractHeaderMapper<org.springframework.ws.soap.SoapMessage>
implements SoapHeaderMapper

A HeaderMapper implementation for mapping to and from a SoapHeader. The AbstractHeaderMapper.setRequestHeaderNames(String[]) and AbstractHeaderMapper.setReplyHeaderNames(String[]) accept exact name Strings or simple patterns (e.g. "start*", "*end", or "*"). By default all inbound headers will be accepted, but any outbound header that should be mapped must be configured explicitly. Note that the outbound mapping only writes String header values into attributes on the SoapHeader. For anything more advanced, one should implement the HeaderMapper interface directly.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Stephane Nicoll, Mauro Molinari, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from class org.springframework.integration.mapping.AbstractHeaderMapper

AbstractHeaderMapper.CompositeHeaderMatcher, AbstractHeaderMapper.ContentBasedHeaderMatcher, AbstractHeaderMapper.HeaderMatcher, AbstractHeaderMapper.PatternBasedHeaderMatcher, AbstractHeaderMapper.PrefixBasedMatcher, AbstractHeaderMapper.SinglePatternBasedHeaderMatcher

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.util.List<java.lang.String>	STANDARD_HEADER_NAMES
protected org.springframework.xml.transform.TransformerHelper	transformerHelper

Fields inherited from class org.springframework.integration.mapping.AbstractHeaderMapper

logger, NON_STANDARD_HEADER_NAME_PATTERN, STANDARD_REPLY_HEADER_NAME_PATTERN, STANDARD_REQUEST_HEADER_NAME_PATTERN

Constructor Summary

Constructors

Constructor and Description
DefaultSoapHeaderMapper()

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	extractStandardHeaders(org.springframework.ws.soap.SoapMessage source) Extract the standard headers from the specified source.
protected java.util.Map<java.lang.String,java.lang.Object>	extractUserDefinedHeaders(org.springframework.ws.soap.SoapMessage source) Extract the user-defined headers from the specified source.
protected void	populateStandardHeaders(java.util.Map<java.lang.String,java.lang.Object> headers, org.springframework.ws.soap.SoapMessage target) Populate the specified standard headers to the specified source.
protected void	populateUserDefinedHeader(java.lang.String headerName, java.lang.Object headerValue, org.springframework.ws.soap.SoapMessage target) Populate the specified user-defined headers to the specified source.

Methods inherited from class org.springframework.integration.mapping.AbstractHeaderMapper

createDefaultHeaderMatcher, createHeaderMatcher, createTargetPropertyName, fromHeadersToReply, fromHeadersToRequest, getHeaderIfAvailable, getTransientHeaderNames, setReplyHeaderNames, setRequestHeaderNames, toHeadersFromReply, toHeadersFromRequest

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.mapping.RequestReplyHeaderMapper

fromHeadersToReply, fromHeadersToRequest, toHeadersFromReply, toHeadersFromRequest

Field Detail

STANDARD_HEADER_NAMES

protected static final java.util.List<java.lang.String> STANDARD_HEADER_NAMES

transformerHelper

protected final org.springframework.xml.transform.TransformerHelper transformerHelper

Constructor Detail

DefaultSoapHeaderMapper

public DefaultSoapHeaderMapper()

Method Detail

extractStandardHeaders

protected java.util.Map<java.lang.String,java.lang.Object> extractStandardHeaders(org.springframework.ws.soap.SoapMessage source)

Description copied from class: AbstractHeaderMapper

Extract the standard headers from the specified source.

Specified by:

extractStandardHeaders in class AbstractHeaderMapper<org.springframework.ws.soap.SoapMessage>

Parameters:

source - the source object to extract standard headers.

Returns:

the map of headers to be mapped.

extractUserDefinedHeaders

protected java.util.Map<java.lang.String,java.lang.Object> extractUserDefinedHeaders(org.springframework.ws.soap.SoapMessage source)

Description copied from class: AbstractHeaderMapper

Extract the user-defined headers from the specified source.

Specified by:

extractUserDefinedHeaders in class AbstractHeaderMapper<org.springframework.ws.soap.SoapMessage>

Parameters:

source - the source object to extract user defined headers.

Returns:

the map of headers to be mapped.

populateStandardHeaders

protected void populateStandardHeaders(java.util.Map<java.lang.String,java.lang.Object> headers,
                                       org.springframework.ws.soap.SoapMessage target)

Description copied from class: AbstractHeaderMapper

Populate the specified standard headers to the specified source.

Specified by:

populateStandardHeaders in class AbstractHeaderMapper<org.springframework.ws.soap.SoapMessage>

Parameters:

headers - the map of standard headers to be populated.

target - the target object to populate headers.

populateUserDefinedHeader

protected void populateUserDefinedHeader(java.lang.String headerName,
                                         java.lang.Object headerValue,
                                         org.springframework.ws.soap.SoapMessage target)

Description copied from class: AbstractHeaderMapper

Populate the specified user-defined headers to the specified source.

Specified by:

populateUserDefinedHeader in class AbstractHeaderMapper<org.springframework.ws.soap.SoapMessage>

Parameters:

headerName - the user defined header name to be populated.

headerValue - the user defined header value to be populated.

target - the target object to populate headers.