Spring Web Services Framework

org.springframework.ws.soap.server.endpoint.mapping
Class SoapActionAnnotationMethodEndpointMapping

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<T>
              extended by org.springframework.ws.server.endpoint.mapping.AbstractAnnotationMethodEndpointMapping<String>
                  extended by org.springframework.ws.soap.server.endpoint.mapping.SoapActionAnnotationMethodEndpointMapping
All Implemented Interfaces:
Aware, ApplicationContextAware, Ordered, EndpointMapping, SoapEndpointMapping

public class SoapActionAnnotationMethodEndpointMapping
extends AbstractAnnotationMethodEndpointMapping<String>
implements SoapEndpointMapping

Implementation of the EndpointMapping interface that uses the SoapAction annotation to map methods to the request SOAPAction header.

Endpoints typically have the following form:

 @Endpoint
 public class MyEndpoint{
    @SoapAction("http://springframework.org/spring-ws/SoapAction")
    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
SoapActionAnnotationMethodEndpointMapping()
           
 
Method Summary
protected  EndpointInvocationChain createEndpointInvocationChain(MessageContext messageContext, Object endpoint, EndpointInterceptor[] interceptors)
          Creates a new SoapEndpointInvocationChain based on the given endpoint, and the set interceptors, and actors/roles.
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.
 void setActorOrRole(String actorOrRole)
          Sets a single SOAP actor/actorOrRole to apply to all endpoints mapped by the delegate endpoint mapping.
 void setActorsOrRoles(String[] actorsOrRoles)
          Sets the array of SOAP actors/actorsOrRoles to apply to all endpoints mapped by the delegate endpoint mapping.
 void setUltimateReceiver(boolean ultimateReceiver)
          Indicates whether this the endpoint fulfills the SOAP 1.2 Ultimate Receiver role.
 
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
getDefaultEndpoint, getEndpoint, getInterceptors, getOrder, initInterceptors, 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
 
Methods inherited from interface org.springframework.ws.server.EndpointMapping
getEndpoint
 

Constructor Detail

SoapActionAnnotationMethodEndpointMapping

public SoapActionAnnotationMethodEndpointMapping()
Method Detail

setActorOrRole

public final void setActorOrRole(String actorOrRole)
Description copied from interface: SoapEndpointMapping
Sets a single SOAP actor/actorOrRole to apply to all endpoints mapped by the delegate endpoint mapping.

Specified by:
setActorOrRole in interface SoapEndpointMapping

setActorsOrRoles

public final void setActorsOrRoles(String[] actorsOrRoles)
Description copied from interface: SoapEndpointMapping
Sets the array of SOAP actors/actorsOrRoles to apply to all endpoints mapped by the delegate endpoint mapping.

Specified by:
setActorsOrRoles in interface SoapEndpointMapping

setUltimateReceiver

public final void setUltimateReceiver(boolean ultimateReceiver)
Description copied from interface: SoapEndpointMapping
Indicates whether this the endpoint fulfills the SOAP 1.2 Ultimate Receiver role.

Specified by:
setUltimateReceiver in interface SoapEndpointMapping

createEndpointInvocationChain

protected final EndpointInvocationChain createEndpointInvocationChain(MessageContext messageContext,
                                                                      Object endpoint,
                                                                      EndpointInterceptor[] interceptors)
Creates a new SoapEndpointInvocationChain based on the given endpoint, and the set interceptors, and actors/roles.

Overrides:
createEndpointInvocationChain in class AbstractEndpointMapping
Parameters:
endpoint - the endpoint
interceptors - the endpoint interceptors
Returns:
the created invocation chain
See Also:
AbstractEndpointMapping.setInterceptors(org.springframework.ws.server.EndpointInterceptor[]), setActorsOrRoles(String[])

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<String>
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<String>
Parameters:
method - the method
Returns:
a registration key, or null if the method is not to be registered

Spring Web Services Framework

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