org.systinet.wasp.dd
Interface ServiceEndpoint

All Superinterfaces:

AttributablePart, ConfigurablePart, DeploymentPart, DocumentablePart, ExtensiblePart, NamedPart

public interface ServiceEndpoint

extends NamedPart, ConfigurablePart, ExtensiblePart, DocumentablePart, AttributablePart

This interface describes WSO2 SOA Enablement Server service part of a deployment descriptor.

Since:

4.0

Component:

Core

Field Summary

static int	OTHER_METHODS_GET Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.
static int	OTHER_METHODS_NONE Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.
static int	TYPE_JAVA Java service using JavaAdaptor.
static int	TYPE_RAW Raw service using RawAdaptor.
static int	TYPE_UNSPECIFIED Service type not explicitly specified.
static int	TYPE_XML XML service using XmlAdaptor.

Method Summary

void	addAcceptingSecurityProvider(java.lang.String providerName) Sets arrays of names of the security providers which have to be activated for this service implementation for accepting incoming requests.
void	addListener(QName listener) Adds listener associated with this service endpoint.
java.util.List	getAcceptingSecurityProviders() Returns list of names of the security providers which have to be activated for this service implementation for accepting incoming requests.
java.lang.String	getInitiatingSecurityProvider() Returns name of the security provider to be used for outgoing calls from this service implementation.
java.lang.String	getInterface() Returns interface of service instance exposed at this endpoint.
java.util.List	getListeners() Returns list of qnames of the listeners associated with this service endpoint.
int	getOtherMethods() Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.
java.lang.String	getPath() Returns the (relative) endpoint of the service.
Processing	getProcessing() Returns the current processing.
ServiceInstance	getServiceInstance() Returns the current service instance.
int	getServiceType() Gets the type of the service.
java.lang.String	getURL() Returns the value for overriding the soap:address location attribute in returned WSDL or null if not set (and WSO2 SOA Enablement Serverautodetects the proper value).
java.lang.String	getVersion() Returns the version of this endpoint or null if it was not specified (default version is 1.0).
QName	getWsdlServiceQName() Returns the name of the WSDL service that will be used as an interface to be called.
java.lang.String	getWsdlURI() Returns the URI of the WSDL document.
java.lang.String	getXMLProtocol() Deprecated. The selection of protocol relies on the WSDL. The default value is stored in clientconf.xml and as top-level element defaultXMLProtocol.
void	setInitiatingSecurityProvider(java.lang.String providerName) Sets name of the security provider to be used for outgoing calls from this service implementation.
void	setInterface(java.lang.String iface) Sets interface of service instance exposed at this endpoint.
void	setOtherMethods(int otherMethods) Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.
void	setPath(java.lang.String path) Sets the (relative) endpoint of the service.
void	setProcessing(Processing processing) Sets processing of this service.
Processing	setProcessing(java.lang.String name) Creates a new Processing object and sets it as processing for this service.
void	setServiceInstance(ServiceInstance serviceInstance) Sets a service instance which will be used as the implementation of this service.
ServiceInstance	setServiceInstance(java.lang.String name, java.lang.String implClass) Creates and a new serviceInstance object ans sets it as the implementation of this service.
void	setServiceType(int type) Gets the type of the service.
void	setURL(java.lang.String url) Sets the soap:address location attribute in returned WSDL.
void	setVersion(java.lang.String version) Sets the version of this endpoint.
void	setWsdlServiceQName(QName wsdlServiceQName) Sets the name of the WSDL service that will be used as an interface to be called.
void	setWsdlURI(java.lang.String wsdlURI) Sets the URI of the WSDL document.
void	setXMLProtocol(java.lang.String protocol) Deprecated. The selection of protocol relies on the WSDL. The default value is stored in clientconf.xml and as top-level element defaultXMLProtocol.

Methods inherited from interface org.systinet.wasp.dd.NamedPart

getName, setName

Methods inherited from interface org.systinet.wasp.dd.DeploymentPart

getDeploymentDescriptor

Methods inherited from interface org.systinet.wasp.dd.ConfigurablePart

getConfiguration

Methods inherited from interface org.systinet.wasp.dd.ExtensiblePart

addElement, getElements

Methods inherited from interface org.systinet.wasp.dd.DocumentablePart

getDocumentation, setDocumentation

Methods inherited from interface org.systinet.wasp.dd.AttributablePart

getAttributes, newAttributes, setAttributes

Field Detail

TYPE_UNSPECIFIED

public static final int TYPE_UNSPECIFIED

Service type not explicitly specified.

See Also:

getServiceType(), setServiceType(int), Constant Field Values

TYPE_JAVA

public static final int TYPE_JAVA

Java service using JavaAdaptor.

See Also:

getServiceType(), setServiceType(int), Constant Field Values

TYPE_XML

public static final int TYPE_XML

XML service using XmlAdaptor.

See Also:

getServiceType(), setServiceType(int), Constant Field Values

TYPE_RAW

public static final int TYPE_RAW

Raw service using RawAdaptor.

See Also:

getServiceType(), setServiceType(int), Constant Field Values

OTHER_METHODS_NONE

public static final int OTHER_METHODS_NONE

Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.

No other methods used (only the default POST method).

See Also:

getOtherMethods(), setOtherMethods(int), Constant Field Values

OTHER_METHODS_GET

public static final int OTHER_METHODS_GET

Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.

GET method used (and also the default POST method).

See Also:

getOtherMethods(), setOtherMethods(int), Constant Field Values

Method Detail

setProcessing

public void setProcessing(Processing processing)

Sets processing of this service.

Parameters:

processing - the processing

setProcessing

public Processing setProcessing(java.lang.String name)
                         throws DuplicatedNameException

Creates a new Processing object and sets it as processing for this service.

Parameters:

name - the local part of the QName of the processing to be added

Returns:

the newly created Processing object

Throws:

DuplicatedNameException

See Also:

NamedPart.setName(java.lang.String)

getProcessing

public Processing getProcessing()

Returns the current processing.

Returns:

the current processing

setServiceInstance

public void setServiceInstance(ServiceInstance serviceInstance)

Sets a service instance which will be used as the implementation of this service.

Parameters:

serviceInstance - the service instance

setServiceInstance

public ServiceInstance setServiceInstance(java.lang.String name,
                                          java.lang.String implClass)
                                   throws DuplicatedNameException

Creates and a new serviceInstance object ans sets it as the implementation of this service.

Parameters:

name - the local part of the QName of the service instance to be added

implClass - the implementation class

Returns:

the newly created ServiceInstance

Throws:

DuplicatedNameException

See Also:

NamedPart.setName(java.lang.String), ImplementablePart.setImplementationClass(java.lang.String)

getServiceInstance

public ServiceInstance getServiceInstance()

Returns the current service instance.

Returns:

the current service instance

getPath

public java.lang.String getPath()

Returns the (relative) endpoint of the service.

Returns:

the path to the service

setPath

public void setPath(java.lang.String path)

Sets the (relative) endpoint of the service.

Parameters:

path - the path being set up

getServiceType

public int getServiceType()

Gets the type of the service. The type determines which adaptor will the service use.

Returns:

service type, see TYPE_UNSPECIFIED(the default one), TYPE_JAVA, TYPE_XML and TYPE_RAW for details

See Also:

TYPE_UNSPECIFIED, TYPE_JAVA, TYPE_XML, TYPE_RAW

setServiceType

public void setServiceType(int type)

Gets the type of the service. The type determines which adaptor will the service use.

Parameters:

type - service type, one of TYPE_UNSPECIFIED(the default one), TYPE_JAVA, TYPE_XML or TYPE_RAW

See Also:

TYPE_UNSPECIFIED, TYPE_JAVA, TYPE_XML, TYPE_RAW

getOtherMethods

public int getOtherMethods()

Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.

Returns other methods used in addition to the default method POST, which is always used. Only GET method is supported now.

Returns:

other method used, see OTHER_METHODS_NONE and OTHER_METHODS_GET for details

See Also:

OTHER_METHODS_NONE, OTHER_METHODS_GET

setOtherMethods

public void setOtherMethods(int otherMethods)

Deprecated. Only raw services (their instance has to implement the org.systinet.wasp.webservice.RawService interface) are bound to both the GET and POST methods.

Sets the methods used in addition to the default method POST. (The POST method is always used, regardless of this setting.) This makes sense for RAW services only.

Parameters:

otherMethods - OTHER_METHODS_NONE or OTHER_METHODS_GET

See Also:

OTHER_METHODS_NONE, OTHER_METHODS_GET

getXMLProtocol

public java.lang.String getXMLProtocol()

Deprecated. The selection of protocol relies on the WSDL. The default value is stored in clientconf.xml and as top-level element defaultXMLProtocol.

Gets the default XML protocol (like SOAP11, SOAP12) through which the service communicates.

Returns:

the default protocol

setXMLProtocol

public void setXMLProtocol(java.lang.String protocol)

Deprecated. The selection of protocol relies on the WSDL. The default value is stored in clientconf.xml and as top-level element defaultXMLProtocol.

Sets the default XML protocol (like SOAP11, SOAP12) through which the service communicates

Parameters:

protocol - the protocol

getWsdlURI

public java.lang.String getWsdlURI()

Returns the URI of the WSDL document.

Returns:

the URI of the WSDL document

setWsdlURI

public void setWsdlURI(java.lang.String wsdlURI)

Sets the URI of the WSDL document.

Parameters:

wsdlURI - the URI of the WSDL document

getWsdlServiceQName

public QName getWsdlServiceQName()

Returns the name of the WSDL service that will be used as an interface to be called.

Returns:

the name of the WSDL service

setWsdlServiceQName

public void setWsdlServiceQName(QName wsdlServiceQName)

Sets the name of the WSDL service that will be used as an interface to be called.

Parameters:

wsdlServiceQName - the name of the WSDL service to be called.

getInitiatingSecurityProvider

public java.lang.String getInitiatingSecurityProvider()

Returns name of the security provider to be used for outgoing calls from this service implementation.

Returns:

name of the security provider for outgoing calls

setInitiatingSecurityProvider

public void setInitiatingSecurityProvider(java.lang.String providerName)

Sets name of the security provider to be used for outgoing calls from this service implementation.

Parameters:

providerName - name of the security provider for outgoing calls

getAcceptingSecurityProviders

public java.util.List getAcceptingSecurityProviders()

Returns list of names of the security providers which have to be activated for this service implementation for accepting incoming requests.

Returns:

list of security provider names for incoming requests

addAcceptingSecurityProvider

public void addAcceptingSecurityProvider(java.lang.String providerName)

Sets arrays of names of the security providers which have to be activated for this service implementation for accepting incoming requests.

Parameters:

providerName - name of the security provider for outgoing calls

getInterface

public java.lang.String getInterface()

Returns interface of service instance exposed at this endpoint.

Returns:

exposed interface of service instance

setInterface

public void setInterface(java.lang.String iface)

Sets interface of service instance exposed at this endpoint.

Parameters:

iface - exposed interface of service instance

setURL

public void setURL(java.lang.String url)

Sets the soap:address location attribute in returned WSDL. Leave unset to let the WSO2 SOA Enablement Server autodetect the service location based on the request. Set to override the autodetection in cases such as placing the WSO2 SOA Enablement Server behind the IP forwarding firewall etc.

Parameters:

url - service location URL used in attribute

Throws:

java.lang.IllegalStateException - when this service endpoint is already published.

getURL

public java.lang.String getURL()

Returns the value for overriding the soap:address location attribute in returned WSDL or null if not set (and WSO2 SOA Enablement Serverautodetects the proper value).

Returns:

service location URI overriding the attribute or null if not specified

getListeners

public java.util.List getListeners()

Returns list of qnames of the listeners associated with this service endpoint.

Returns:

list of listeners

addListener

public void addListener(QName listener)

Adds listener associated with this service endpoint.

Parameters:

listener - listener to add

getVersion

public java.lang.String getVersion()

Returns the version of this endpoint or null if it was not specified (default version is 1.0).

Returns:

the version

setVersion

public void setVersion(java.lang.String version)

Sets the version of this endpoint. It is useful when deploying several versions of service to the same path. The version is a string containing integers separated by dots. Versions are compared in sych way, that version "2.10.1" is newer than "2.10" (which is equal to "2.10.0" and 1 > 0) and "2.10" is newer than "2.3" (because 10 > 3).

Parameters:

version - the version or null for default version (1.0)