org.springframework.ws.server.endpoint.mapping

Class UriEndpointMapping

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

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

org.springframework.ws.server.endpoint.mapping.AbstractMapBasedEndpointMapping

org.springframework.ws.server.endpoint.mapping.UriEndpointMapping

All Implemented Interfaces:

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

public class UriEndpointMapping
extends AbstractMapBasedEndpointMapping

Implementation of the EndpointMapping interface to map from the full request URI or request URI path to endpoint beans. Supports both mapping to bean instances and mapping to bean names: the latter is required for prototype handlers.

When the usePath property is enabled, the mapping will be based on the URI path rather than the full URI.

The endpointMap property is suitable for populating the endpoint map with bean references, e.g. via the map element in XML bean definitions.

Mappings to bean names can be set via the mappings property, in a form accepted by the java.util.Properties class, like as follows:

 http://example.com:8080/services/bookFlight=bookFlightEndpoint
 jms://exampleQueue=getFlightsEndpoint
 

or, when the usePath property is enabled:

 /services/bookFlight=bookFlightEndpoint
 

The syntax is [URI|PATH]=ENDPOINT_BEAN_NAME.

This endpoint mapping does not read from the request message, and therefore is more suitable for message factories which directly read from the transport request (such as the AxiomSoapMessageFactory with the payloadCaching disabled). However, this endpoint mapping obviously is transport specific.

Since:

1.5.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

Constructors

Constructor and Description
UriEndpointMapping()

Method Summary

Modifier and Type	Method and Description
protected String	getLookupKeyForMessage(MessageContext messageContext) Returns the the endpoint key for the given message context.
void	setUsePath(boolean usePath) Indicates whether the path should be used instead of the full URI.
protected boolean	validateLookupKey(String key) Validates the given endpoint key.

Methods inherited from class org.springframework.ws.server.endpoint.mapping.AbstractMapBasedEndpointMapping

getEndpointInternal, initApplicationContext, lookupEndpoint, registerEndpoint, setEndpointMap, setLazyInitEndpoints, setMappings, setRegisterBeanNames

Methods inherited from class org.springframework.ws.server.endpoint.mapping.AbstractEndpointMapping

createEndpointInvocationChain, 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

Constructor Detail

UriEndpointMapping

public UriEndpointMapping()

Method Detail

setUsePath

public void setUsePath(boolean usePath)

Indicates whether the path should be used instead of the full URI. Default is false.

Since:

2.1.1

validateLookupKey

protected boolean validateLookupKey(String key)

Description copied from class: AbstractMapBasedEndpointMapping

Validates the given endpoint key. Should return true is the given string is valid.

Specified by:

validateLookupKey in class AbstractMapBasedEndpointMapping

getLookupKeyForMessage

protected String getLookupKeyForMessage(MessageContext messageContext)
                                 throws Exception

Description copied from class: AbstractMapBasedEndpointMapping

Returns the the endpoint key for the given message context. Returns null if a key cannot be found.

Specified by:

getLookupKeyForMessage in class AbstractMapBasedEndpointMapping

Returns:

the registration key; or null

Throws:

Exception