org.reficio.ws.server.endpoint

Class GenericContextDomEndpoint

java.lang.Object

org.reficio.ws.server.endpoint.GenericContextDomEndpoint

All Implemented Interfaces:

ContextPayloadEndpoint, org.springframework.beans.factory.InitializingBean, org.springframework.ws.server.endpoint.PayloadEndpoint

public class GenericContextDomEndpoint
extends Object
implements ContextPayloadEndpoint, org.springframework.beans.factory.InitializingBean

Implementation of the ContextPayloadEndpoint and AbstractDomPayloadEndpoint. It handles all SOAP requests. It checks the context path of the request and then gets the responder registered under that context path. If an responder exists it is invoked passing the message context to it, if it does not exist an exception is thrown. It also contains the API to register, unregister responders and get all responders registered in this endpoint.

Since:

1.0.0

Author:

Tom Bujok

Constructor Summary

Constructors

Constructor and Description
GenericContextDomEndpoint()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
Enumeration<String>	getRegisteredContextPaths()
Source	invoke(org.springframework.ws.context.MessageContext messageContext) Implementation of the invoke message that gets the MessageContext.
Source	invoke(Source request) Empty method included here to be compliant with the PayloadEndpoint.
void	registerRequestResponder(String contextPath, RequestResponder responder) Enables to register a responder under the specified context path
void	unregisterRequestResponder(String contextPath) Unregisters the responder from the specified context path

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericContextDomEndpoint

public GenericContextDomEndpoint()

Method Detail

invoke

public Source invoke(org.springframework.ws.context.MessageContext messageContext)

Implementation of the invoke message that gets the MessageContext. It enables the responders to the the whole SOAP envelope (and not only the request element); The responders are invoked with that context. If there's no responder an exception is thrown.

Specified by:

invoke in interface ContextPayloadEndpoint

Parameters:

messageContext - the context of the message containing the request and (possible response)

Returns:

the payload of the response message, may be null to indicate no response

registerRequestResponder

public void registerRequestResponder(String contextPath,
                                     RequestResponder responder)
                              throws ServiceRegistrationException

Enables to register a responder under the specified context path

Parameters:

contextPath - to be used by the responder

responder - request responder

Throws:

ServiceRegistrationException - thrown if error occurs, for example path is already taken

unregisterRequestResponder

public void unregisterRequestResponder(String contextPath)
                                throws ServiceRegistrationException

Unregisters the responder from the specified context path

Parameters:

contextPath - context path from which the responder should be removed

Throws:

ServiceRegistrationException - thrown if error occurs, for example no service under the specified path

getRegisteredContextPaths

public Enumeration<String> getRegisteredContextPaths()

Returns:

Returns an enumeration of the taken context paths

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

invoke

public Source invoke(Source request)
              throws Exception

Empty method included here to be compliant with the PayloadEndpoint. Not used here as it does not enable the user to get the whole SOAP envelope.

Specified by:

invoke in interface org.springframework.ws.server.endpoint.PayloadEndpoint

Throws:

Exception