org.systinet.wasp.dd
Interface ServiceClient

All Superinterfaces:

AttributablePart, ConfigurablePart, DeploymentPart, DocumentablePart, ExtensiblePart

public interface ServiceClient

extends DeploymentPart, ConfigurablePart, ExtensiblePart, DocumentablePart, AttributablePart

This interface describes configuration of a client of a service.

Since:

4.0

Component:

Core

Method Summary

void	addListener(QName listener) Adds listener associated with this service client.
java.lang.Integer	getAsyncTimeout() Gets the timeout of the asynchronous operation.
java.lang.String	getAsyncTransport() Returns the name of an asynchronous protocol used.
java.lang.String	getInitiatingSecurityProvider() Returns name of the security provider to be used for outgoing calls from this service implementation.
java.util.List	getListeners() Returns list of qnames of the listeners associated with this service client.
Processing	getProcessing() Returns the current processing.
QName	getServicePortName() Returns the name of port name of the service selectend.
QName	getServicePortType() Deprecated. Use getServicePortName() instead.
Endpoint	getServiceURI() Deprecated. use getServiceURL() instead
Endpoint	getServiceURL() Returns the endpoint of the service.
java.lang.String	getXMLProtocol() Deprecated. The selection of the protocol relies on the WSDL (and the port selected) and on the value of the CallContext.XML_PROTOCOL set to the CallContext.
void	setAsyncTimeout(java.lang.Integer asyncTimeout) Sets the timeout of the asynchronous operation.
void	setAsyncTransport(java.lang.String asyncTransport) Adds a name of protocol used.
void	setInitiatingSecurityProvider(java.lang.String providerName) Sets name of the security provider to be used for outgoing calls from this service implementation.
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	setServicePortName(QName portName) Returns the name of port name of the service selectend.
void	setServicePortType(QName portType) Deprecated. Use setServicePortName(javax.xml.namespace.QName) instead.
void	setServiceURI(Endpoint endpoint) Deprecated. use setServiceURL(org.idoox.transport.client.Endpoint) instead
void	setServiceURL(Endpoint endpoint) Sets the endpoint of this service.
void	setXMLProtocol(java.lang.String protocol) Deprecated. The selection of the protocol relies on the WSDL (and the port selected) and on the value of the CallContext.XML_PROTOCOL set to the CallContext.

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

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

getServiceURI

public Endpoint getServiceURI()

Deprecated. use getServiceURL() instead

setServiceURI

public void setServiceURI(Endpoint endpoint)

Deprecated. use setServiceURL(org.idoox.transport.client.Endpoint) instead

getServiceURL

public Endpoint getServiceURL()

Returns the endpoint of the service. When set up, servicePortName must be null.

Returns:

endpoint of the service

setServiceURL

public void setServiceURL(Endpoint endpoint)

Sets the endpoint of this service. When set up, servicePortName must be null.

Parameters:

endpoint - the endpoint of the service

getServicePortType

public QName getServicePortType()

Deprecated. Use getServicePortName() instead.

Returns the name of port type. When set up, serviceURL must be null.

Returns:

name of port type.

setServicePortType

public void setServicePortType(QName portType)

Deprecated. Use setServicePortName(javax.xml.namespace.QName) instead.

Sets the name of port type. When set up, serviceURL must be null.

Parameters:

portType - name of port type

getServicePortName

public QName getServicePortName()

Returns the name of port name of the service selectend. When set up, serviceURL must be null.

Returns:

name of the port

setServicePortName

public void setServicePortName(QName portName)

Returns the name of port name of the service selectend. When set up, serviceURL must be null.

Parameters:

portName - name of the port

getXMLProtocol

public java.lang.String getXMLProtocol()

Deprecated. The selection of the protocol relies on the WSDL (and the port selected) and on the value of the CallContext.XML_PROTOCOL set to the CallContext.

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 the protocol relies on the WSDL (and the port selected) and on the value of the CallContext.XML_PROTOCOL set to the CallContext.

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

Parameters:

protocol - the protocol

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

setAsyncTransport

public void setAsyncTransport(java.lang.String asyncTransport)

Adds a name of protocol used.

Parameters:

asyncTransport - name of the protocol

getAsyncTransport

public java.lang.String getAsyncTransport()

Returns the name of an asynchronous protocol used.

Returns:

name of the protocol

setAsyncTimeout

public void setAsyncTimeout(java.lang.Integer asyncTimeout)

Sets the timeout of the asynchronous operation.

Parameters:

asyncTimeout - the timeout value, null if unspecified

getAsyncTimeout

public java.lang.Integer getAsyncTimeout()

Gets the timeout of the asynchronous operation.

Returns:

the timeout value, null if unspecified

getListeners

public java.util.List getListeners()

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

Returns:

list of listeners

addListener

public void addListener(QName listener)

Adds listener associated with this service client.

Parameters:

listener - listener to add