ServiceEndpoint (WSO2 SOA Enablement Server for Java 6.6 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.systinet.wasp.webservice
Class ServiceEndpoint

java.lang.Object
  org.systinet.wasp.webservice.ServiceEndpoint

All Implemented Interfaces:: Processing

public abstract class ServiceEndpoint
extends java.lang.Object
implements Processing

ServiceEndpoint represents one webservice endpoint. Using this class, one can fully setup various endpoint properties and processors affecting message processing such as handlers, interceptors etc. Common usage is as following:

 ServiceEndpoint service = ServiceEndpoint.create("/HelloWorld", new HelloService());
 service.set...;
 ...
 Registry.publish(service);

Since:: 4.5
Component:: Core

Field Summary
`static int`	`TYPE_JAVA` Java type of webservice.
`static int`	`TYPE_RAW` Raw type of webservice.
`static int`	`TYPE_XML` XML type of webservice.
`static java.lang.String`	`XML_PROTOCOL_SOAP11` Deprecated. See `setXMLProtocol(java.lang.String)`.
`static java.lang.String`	`XML_PROTOCOL_SOAP12` Deprecated. See `setXMLProtocol(java.lang.String)`.

Constructor Summary
`protected`	`ServiceEndpoint()`

Method Summary
`abstract void`	`addListener(ServiceEndpointListener listener)` Adds listener to this service endpoint.
`static ServiceEndpoint`	`create(java.lang.String path, java.lang.Class implementationClass)` Creates new instance of ServiceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, java.lang.Class implementationClass, java.lang.Class iface)` Creates new instance of ServiceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, java.lang.Object implementationObject)` Creates new instance of ServiceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, java.lang.Object implementationObject, java.lang.Class iface)` Creates new instance of ServiceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, ServiceEndpoint serviceEndpoint)` Creates new instance of ServiceEndpoint based on supplied serviceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, ServiceEndpoint serviceEndpoint, java.lang.Class iface)` Creates new instance of ServiceEndpoint based on supplied serviceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, ServiceInstance serviceInstance)` Creates new instance of ServiceEndpoint.
`static ServiceEndpoint`	`create(java.lang.String path, ServiceInstance serviceInstance, java.lang.Class iface)` Creates new instance of ServiceEndpoint.
`abstract Attributes`	`getAttributes()` Retrieves attributes store bound to this service endpoint.
`abstract Configurable`	`getConfigurable()` Returns the custom configuration of the service endpoint.
`abstract ServiceEndpointContext`	`getContext()` Retrieves unique context bound to this service endpoint.
`abstract java.lang.Class`	`getInterface()` Retrieves endpoint iface if set.
`abstract java.lang.String`	`getPath()` Retrieves server path of this endpoint.
`abstract ServiceInstance`	`getServiceInstance()` Retrieves service instance bound to this endpoint.
`abstract int`	`getServiceType()` Retrieves type of this service endpoint based on implementation interface.
`abstract java.lang.String`	`getServiceURL()` Returns the value for overriding the soap:address location attribute in returned WSDL or `null` if not set (and WSO2 SOA Enablement Server autodetects the proper value).
`abstract java.lang.String`	`getVersion()` Returns the version of this endpoint.
`abstract Definition`	`getWSDL()` Retrieves WSDL definition for this service endpoint (either set by calling `setWSDL(javax.wsdl.Definition)` or generated upon publishing) or `null`, if this service endpoint was not published yet and no WSDL was set by user.
`abstract java.lang.String`	`getWSDLPortName()` Returns the name of service port in the WSDL definition.
`abstract QName`	`getWSDLServiceName()` Returns name of selected service in the WSDL definition (see also `setWSDLServiceName(javax.xml.namespace.QName)`.
`abstract java.lang.String`	`getXMLProtocol()` Deprecated. This methods returns XML protocol set by `setXMLProtocol(java.lang.String)`. Inside any XML processing unit (e.g. JAX-RPC handler) you can get version of used XML protocol from `CallContext` (see `CallContext.XML_PROTOCOL`).
`abstract void`	`removeListener(ServiceEndpointListener listener)` Removes listener form this service endpoint.
`abstract void`	`setConfigurable(Configurable configurable)` Sets the custom configuration of the service service endpoint.
`abstract void`	`setInterface(java.lang.Class iface)` Sets iface.
`abstract void`	`setPath(java.lang.String path)` Sets the service endpoint server path.
`abstract void`	`setServiceURL(java.lang.String url)` Sets the soap:address location attribute in returned WSDL.
`abstract void`	`setVersion(java.lang.String version)` Sets the version of this endpoint.
`abstract void`	`setWSDL(Definition wsdl)` Sets WSDL definition for this service endpoint.
`abstract void`	`setWSDLPortName(java.lang.String portName)` Sets the name of service port in WSDL definition.
`abstract void`	`setWSDLServiceName(QName serviceName)` Sets name of service in the WSDL definition.
`abstract void`	`setXMLProtocol(java.lang.String protocol)` Deprecated. XML protocol of the service is determined by WSDL. Use `Java2WSDL` and `Java2WSDL.setProtocol` to generate WSDL for required XML protocol and set this WSDL to this `ServiceEndpoint` with `setWSDL(javax.wsdl.Definition)`. You can set XML protocol for the service with this code: ServiceEndpoint endpoint = ServiceEndpoint.create("/MyEndpoint", new MyService()); Java2WSDL java2wsdl = Java2WSDLFactory.newJava2WSDL(); java2wsdl.setProtocol(Java2WSDL.PROTOCOL_SOAP11_SOAP12); Definition wsdl = java2wsdl.generateDefinition(MyService.class); endpoint.setWSDL(wsdl); Registry.publish(endpoint);

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.systinet.wasp.webservice.Processing

getHandlers, getHeaderProcessors, getInterceptors

Field Detail

TYPE_JAVA

public static final int TYPE_JAVA

Java type of webservice. This is used by getServiceType(). This type of webservice has instance which can implement arbitrary interface.

See Also:: Constant Field Values

TYPE_XML

public static final int TYPE_XML

XML type of webservice. This is used by getServiceType(). This type of webservice has instance which must implement ReqRespListener or OnewayListener.

See Also:: Constant Field Values

TYPE_RAW

public static final int TYPE_RAW

Raw type of webservice. This is used by getServiceType(). This type of webservice has instance which must implement RawService.

See Also:: Constant Field Values

XML_PROTOCOL_SOAP11

public static final java.lang.String XML_PROTOCOL_SOAP11

Deprecated. See setXMLProtocol(java.lang.String).

SOAP11 as XML protocol. This is used by getXMLProtocol() and setXMLProtocol(java.lang.String).

See Also:: Constant Field Values

XML_PROTOCOL_SOAP12

public static final java.lang.String XML_PROTOCOL_SOAP12

Deprecated. See setXMLProtocol(java.lang.String).

SOAP12 as XML protocol. This is used by getXMLProtocol() and setXMLProtocol(java.lang.String).

See Also:: Constant Field Values

Constructor Detail

ServiceEndpoint

protected ServiceEndpoint()

Method Detail