Class PayloadRootAnnotationMethodEndpointMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping

org.springframework.ws.server.endpoint.mapping.AbstractMethodEndpointMapping<QName>

org.springframework.ws.server.endpoint.mapping.AbstractAnnotationMethodEndpointMapping<QName>

org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.core.Ordered, EndpointMapping

public class PayloadRootAnnotationMethodEndpointMapping
extends AbstractAnnotationMethodEndpointMapping<QName>

Implementation of the EndpointMapping interface that uses the PayloadRoot annotation to map methods to request payload root elements.

Endpoints typically have the following form:

@Endpoint
public class MyEndpoint{
  @PayloadRoot(localPart = "Request",
                           namespace = "http://springframework.org/spring-ws")
  public Source doSomethingWithRequest() {
         ...
  }
}

Since:

1.0.0

Field Summary

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

logger

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
PayloadRootAnnotationMethodEndpointMapping()

Method Summary

Modifier and Type	Method	Description
protected @Nullable QName	getLookupKeyForMessage(MessageContext messageContext)	Returns the endpoint keys for the given message context.
protected List<QName>	getLookupKeysForMethod(Method method)	Returns the endpoint keys for the given method.
static void	setTransformerFactory(TransformerFactory transformerFactory)	Override the default TransformerFactory.

Methods inherited from class AbstractAnnotationMethodEndpointMapping

getEndpointAnnotationType, initApplicationContext, setDetectEndpointsInAncestorContexts

Methods inherited from class AbstractMethodEndpointMapping

getEndpointClass, getEndpointInternal, getLookupKeyForMethod, lookupEndpoint, registerEndpoint, registerMethods, registerMethods

Methods inherited from class AbstractEndpointMapping

createEndpointInvocationChain, getDefaultEndpoint, getEndpoint, getInterceptors, getOrder, initInterceptors, resolveStringEndpoint, setDefaultEndpoint, setInterceptors, setOrder

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Constructor Details

PayloadRootAnnotationMethodEndpointMapping

public PayloadRootAnnotationMethodEndpointMapping()

Method Details

setTransformerFactory

public static void setTransformerFactory(TransformerFactory transformerFactory)

Override the default TransformerFactory.

Parameters:

transformerFactory - the transformer factory to use

getLookupKeyForMessage

protected @Nullable QName getLookupKeyForMessage(MessageContext messageContext)
                                          throws Exception

Description copied from class: AbstractMethodEndpointMapping

Returns the endpoint keys for the given message context.

Specified by:

getLookupKeyForMessage in class AbstractMethodEndpointMapping<QName>

Returns:

the registration keys

Throws:

Exception

getLookupKeysForMethod

protected List<QName> getLookupKeysForMethod(Method method)

Description copied from class: AbstractMethodEndpointMapping

Returns the endpoint keys for the given method. Should return an empty array if the method is not to be registered. The default delegates to AbstractMethodEndpointMapping.getLookupKeyForMethod(Method).

Overrides:

getLookupKeysForMethod in class AbstractMethodEndpointMapping<QName>

Parameters:

method - the method

Returns:

a list of registration keys