org.springframework.ws.config.annotation

Class WsConfigurationSupport

java.lang.Object

org.springframework.ws.config.annotation.WsConfigurationSupport

Direct Known Subclasses:

DelegatingWsConfiguration

public class WsConfigurationSupport
extends Object

This is the main class providing the configuration behind the Spring Web Services Java config. It is typically imported by adding @EnableWs to an application @Configuration class. An alternative, more advanced option is to extend directly from this class and override methods as necessary remembering to add @Configuration to the subclass and @Bean to overridden @Bean methods. For more details see the Javadoc of @EnableWs.

This class registers the following EndpointMappings:

• PayloadRootAnnotationMethodEndpointMapping ordered at 0 for mapping requests to @PayloadRoot annotated controller methods.
• SoapActionAnnotationMethodEndpointMapping ordered at 1 for mapping requests to @SoapAction annotated controller methods.
• AnnotationActionEndpointMapping ordered at 2 for mapping requests to @Action annotated controller methods.

Registers one EndpointAdapter:

• DefaultMethodEndpointAdapter for processing requests with annotated endpoint methods.

Registers the following EndpointExceptionResolvers:

• SoapFaultAnnotationExceptionResolver for handling exceptions annotated with @SoapFault.
• SimpleSoapExceptionResolver for creating default exceptions.

Since:

2.2

Author:

Arjen Poutsma

See Also:

EnableWs, WsConfigurer, WsConfigurerAdapter

Constructor Summary

Constructors

Constructor and Description
WsConfigurationSupport()

Method Summary

Modifier and Type	Method and Description
protected void	addArgumentResolvers(List<MethodArgumentResolver> argumentResolvers) Add custom MethodArgumentResolvers to use in addition to the ones registered by default.
protected void	addInterceptors(List<EndpointInterceptor> interceptors) Template method to add endpoint interceptors.
protected void	addReturnValueHandlers(List<MethodReturnValueHandler> returnValueHandlers) Add custom MethodReturnValueHandlers in addition to the ones registered by default.
AnnotationActionEndpointMapping	annotationActionEndpointMapping() Returns a AnnotationActionEndpointMapping ordered at 2 for mapping requests to annotated endpoints.
DefaultMethodEndpointAdapter	defaultMethodEndpointAdapter() Returns a DefaultMethodEndpointAdapter for processing requests through annotated endpoint methods.
protected EndpointInterceptor[]	getInterceptors() Provide access to the shared handler interceptors used to configure EndpointMapping instances with.
PayloadRootAnnotationMethodEndpointMapping	payloadRootAnnotationMethodEndpointMapping() Returns a PayloadRootAnnotationMethodEndpointMapping ordered at 0 for mapping requests to annotated endpoints.
SimpleSoapExceptionResolver	simpleSoapExceptionResolver() Returns a SimpleSoapExceptionResolver ordered at lowest precedence for handling endpoint exceptions.
SoapActionAnnotationMethodEndpointMapping	soapActionAnnotationMethodEndpointMapping() Returns a SoapActionAnnotationMethodEndpointMapping ordered at 1 for mapping requests to annotated endpoints.
SoapFaultAnnotationExceptionResolver	soapFaultAnnotationExceptionResolver() Returns a SoapFaultAnnotationExceptionResolver ordered at 0 for handling endpoint exceptions.

Methods inherited from class java.lang.Object

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

Constructor Detail

WsConfigurationSupport

public WsConfigurationSupport()

Method Detail

payloadRootAnnotationMethodEndpointMapping

@Bean
public PayloadRootAnnotationMethodEndpointMapping payloadRootAnnotationMethodEndpointMapping()

Returns a PayloadRootAnnotationMethodEndpointMapping ordered at 0 for mapping requests to annotated endpoints.

soapActionAnnotationMethodEndpointMapping

@Bean
public SoapActionAnnotationMethodEndpointMapping soapActionAnnotationMethodEndpointMapping()

Returns a SoapActionAnnotationMethodEndpointMapping ordered at 1 for mapping requests to annotated endpoints.

annotationActionEndpointMapping

@Bean
public AnnotationActionEndpointMapping annotationActionEndpointMapping()

Returns a AnnotationActionEndpointMapping ordered at 2 for mapping requests to annotated endpoints.

getInterceptors

protected final EndpointInterceptor[] getInterceptors()

Provide access to the shared handler interceptors used to configure EndpointMapping instances with. This method cannot be overridden, use addInterceptors(List) instead.

addInterceptors

protected void addInterceptors(List<EndpointInterceptor> interceptors)

Template method to add endpoint interceptors. Override this method to add Spring-WS interceptors for pre- and post-processing of endpoint invocation.

defaultMethodEndpointAdapter

@Bean
public DefaultMethodEndpointAdapter defaultMethodEndpointAdapter()

Returns a DefaultMethodEndpointAdapter for processing requests through annotated endpoint methods. Consider overriding one of these other more fine-grained methods:

• addArgumentResolvers(List) for adding custom argument resolvers.
• addReturnValueHandlers(List) for adding custom return value handlers.

addArgumentResolvers

protected void addArgumentResolvers(List<MethodArgumentResolver> argumentResolvers)

Add custom MethodArgumentResolvers to use in addition to the ones registered by default.

Parameters:

argumentResolvers - the list of custom converters; initially an empty list.

addReturnValueHandlers

protected void addReturnValueHandlers(List<MethodReturnValueHandler> returnValueHandlers)

Add custom MethodReturnValueHandlers in addition to the ones registered by default.

Parameters:

returnValueHandlers - the list of custom handlers; initially an empty list.

soapFaultAnnotationExceptionResolver

@Bean
public SoapFaultAnnotationExceptionResolver soapFaultAnnotationExceptionResolver()

Returns a SoapFaultAnnotationExceptionResolver ordered at 0 for handling endpoint exceptions.

simpleSoapExceptionResolver

@Bean
public SimpleSoapExceptionResolver simpleSoapExceptionResolver()

Returns a SimpleSoapExceptionResolver ordered at lowest precedence for handling endpoint exceptions.