javax.xml.rpc
Interface Service

public interface Service

A service class acts as a factory of the following objects:

• Dynamic proxy for a service port.
• Instance of the type javax.xml.rpc.Call for the dynamic invocation of a remote operation on a service port.
• Instance of a generated static stub class

The Service implementation class is required to implement java.io.Serializable and javax.naming.Referenceable interfaces to support registration in the JNDI namespace.

Method Summary

Call	createCall() Creates an empty Call object that needs to be configured using the setter methods on the Call interface.
Call	createCall(QName portName) Creates a Call instance.
Call	createCall(QName portName, java.lang.String operationName) Creates a Call instance.
java.rmi.Remote	getPort(QName portName, java.lang.Class proxyInterface) The getPort method returns a dynamic proxy for the specified service port.
java.util.Iterator	getPorts() Gets the list of qualified names of the ports grouped by this service
QName	getServiceName() Gets the name of this Service.
TypeMappingRegistry	getTypeMappingRegistry() Gets the TypeMappingRegistry registered with this Service object
java.net.URL	getWSDLDocumentLocation() Gets location of the WSDL document for this Service.
void	setTypeMappingRegistry(TypeMappingRegistry registry) Registers a type mapping registry with this Service object.

Method Detail

getPort

public java.rmi.Remote getPort(QName portName,
                               java.lang.Class proxyInterface)
                        throws JAXRPCException

The getPort method returns a dynamic proxy for the specified service port. A service client uses this dynamic proxy to invoke operations on the target service port. The proxyInterface specifies the service definition interface that is supported by the created dynamic proxy.

Parameters:

portName - Qualified name of the service port in the WSDL based service description

proxyInterface - Service definition interface supported by the dynamic proxy

Returns:

Dynamic proxy object that supports the service definition interface that extends the java.rmi.Remote

Throws:

JAXRPCException - If the service class fails to create a dynamic proxy

java.lang.IllegalArgumentException -

createCall

public Call createCall(QName portName)
                throws JAXRPCException

Creates a Call instance.

Parameters:

portName - The qualified name for the target service port

Returns:

Call object

Throws:

JAXRPCException - If the Service class fails to create a Call object

createCall

public Call createCall(QName portName,
                       java.lang.String operationName)
                throws JAXRPCException

Creates a Call instance.

Parameters:

portName - The qualified name for the target service port

operationName - Name of the operation for which this Call object is created.

Returns:

Call object

Throws:

JAXRPCException - If the Service class fails to create a Call object

createCall

public Call createCall()
                throws JAXRPCException

Creates an empty Call object that needs to be configured using the setter methods on the Call interface.

Returns:

Call object

Throws:

JAXRPCException -

getServiceName

public QName getServiceName()

Gets the name of this Service.

Returns:

Qualified name of this service

getPorts

public java.util.Iterator getPorts()

Gets the list of qualified names of the ports grouped by this service

Returns:

java.util.Iterator

getWSDLDocumentLocation

public java.net.URL getWSDLDocumentLocation()

Gets location of the WSDL document for this Service.

Returns:

Location of the WSDL document for this service

setTypeMappingRegistry

public void setTypeMappingRegistry(TypeMappingRegistry registry)
                            throws JAXRPCException

Registers a type mapping registry with this Service object.

Parameters:

registry - TypeMappingRegistry object

Throws:

java.lang.UnsupportedOperation-Exception - if the Service class does not support the configuration of a TypeMappingRegistry

JAXRPCException - if there is an error in the configuration of the TypeMappingRegistry

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()
                                           throws JAXRPCException

Gets the TypeMappingRegistry registered with this Service object

Returns:

The configured TypeMappingRegistry or null if no TypeMappingRegistry has been set on the Service object

Throws:

java.lang.UnsupportedOperation-Exception - if the Service class does not support the configuration of a TypeMappingRegistry