Spring Web Services Framework

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

java.lang.Object
  extended by org.springframework.context.support.ApplicationObjectSupport
      extended by org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping
          extended by org.springframework.ws.server.endpoint.mapping.AbstractMethodEndpointMapping
              extended by org.springframework.ws.server.endpoint.mapping.AbstractAnnotationMethodEndpointMapping
                  extended by org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping
All Implemented Interfaces:
ApplicationContextAware, Ordered, EndpointMapping

public class PayloadRootAnnotationMethodEndpointMapping
extends AbstractAnnotationMethodEndpointMapping

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
Author:
Arjen Poutsma

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
PayloadRootAnnotationMethodEndpointMapping()
           
 
Method Summary
protected  String getLookupKeyForMessage(MessageContext messageContext)
          Returns the the endpoint keys for the given message context.
protected  String getLookupKeyForMethod(Method method)
          Returns the the endpoint keys for the given method.
 
Methods inherited from class org.springframework.ws.server.endpoint.mapping.AbstractAnnotationMethodEndpointMapping
getEndpointAnnotationType, initApplicationContext, setDetectEndpointsInAncestorContexts
 
Methods inherited from class org.springframework.ws.server.endpoint.mapping.AbstractMethodEndpointMapping
getEndpointClass, getEndpointInternal, lookupEndpoint, registerEndpoint, registerMethods, registerMethods
 
Methods inherited from class org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping
createEndpointInvocationChain, getDefaultEndpoint, getEndpoint, getInterceptors, getOrder, resolveStringEndpoint, setDefaultEndpoint, setInterceptors, setOrder
 
Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, requiredContextClass, setApplicationContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PayloadRootAnnotationMethodEndpointMapping

public PayloadRootAnnotationMethodEndpointMapping()
Method Detail

getLookupKeyForMessage

protected String getLookupKeyForMessage(MessageContext messageContext)
                                 throws Exception
Description copied from class: AbstractMethodEndpointMapping
Returns the the endpoint keys for the given message context.

Specified by:
getLookupKeyForMessage in class AbstractMethodEndpointMapping
Returns:
the registration keys
Throws:
Exception

getLookupKeyForMethod

protected String getLookupKeyForMethod(Method method)
Description copied from class: AbstractMethodEndpointMapping
Returns the the endpoint keys for the given method. Returns null if the method is not to be registered, which is the default.

Overrides:
getLookupKeyForMethod in class AbstractMethodEndpointMapping
Parameters:
method - the method
Returns:
a registration key, or null if the method is not to be registered

Spring Web Services Framework

Copyright © 2005-2010 The Spring Web Services Framework. All Rights Reserved.