org.ow2.jonas.ws.jaxws
Interface IWebServiceEndpoint

All Known Subinterfaces:

IEJBWebserviceEndpoint

All Known Implementing Classes:

Axis2EJBWebserviceEndpoint, Axis2WSEndpoint, CXFEJBWebserviceEndpoint, CXFWSEndpoint

public interface IWebServiceEndpoint

An IWebServiceEndpoint is a container around a concrete endpoint implementation (Axis2 or CXF for example, but not limited to). It is mapped to a wsdl:port and is associated to a WSDL that provides a technical description of this web service.
It provides a management interface that an administrator can use to "explore" the web service.
It also has a runtime interface that has to be used to invoke the web service. This runtime interface is a simple invoke method with 2 parameters (IWSRequest and IWSResponse) wrapping input and output messages streams. The IWSRequest and IWSResponse interfaces has to be implemented to adapt a given InputStream to the WS stream (like wrapping a HttpServletRequest and a HttpServletResponse for a webcontainer).

Author:

Guillaume Sauthier

Nested Class Summary

static class

IWebServiceEndpoint.EndpointType Supported endpoint types: can be EJB (Stateless Session Beans) or POJO.

Method Summary

void	displayInfos() Prints info about the endPoint.
PortIdentifier	getIdentifier()
PortMetaData	getPortMetaData() Give access to the port's metadata: context-root url-pattern hostname ...
IWebServiceEndpoint.EndpointType	getType()
void	invoke(IWSRequest request, IWSResponse response) Invoke this web service endpoint.
void	start() Starts the IWebServiceEndpoint.
void	stop() Stops the IWebServiceEndpoint.

Method Detail

getType

IWebServiceEndpoint.EndpointType getType()

Returns:

this IWebServiceEndpoint's implementation type (EJB or POJO)

getIdentifier

PortIdentifier getIdentifier()

Returns:

the port identifier of this endpoint.

invoke

void invoke(IWSRequest request,
            IWSResponse response)
            throws WSException

Invoke this web service endpoint. SOAP Message content (XML) can be found in the IWSRequest object. The response has to be written back into the IWSResponse object.

Parameters:

request - Request wrapper

response - Response wrapper

Throws:

WSException - thrown if anything goes wrong in the invocation processing

start

void start()

Starts the IWebServiceEndpoint. Can be used for initialization code.

stop

void stop()

Stops the IWebServiceEndpoint. Any resource used by the endpoint should be cleared after this method's call.

getPortMetaData

PortMetaData getPortMetaData()

Give access to the port's metadata:

• context-root
• url-pattern
• hostname
• ...

Returns:

the metadata informations associated with this endpoint.

displayInfos

void displayInfos()

Prints info about the endPoint.