javax.xml.rpc

Interface Service

public interface Service

Service class acts as a factory of the following:
Method Summary
CallcreateCall(QName portName)
Creates a Call instance.
CallcreateCall(QName portName, QName operationName)
Creates a Call instance.
CallcreateCall(QName portName, String operationName)
Creates a Call instance.
CallcreateCall()
Creates a Call object not associated with specific operation or target service endpoint.
Call[]getCalls(QName portName)
Gets an array of preconfigured Call objects for invoking operations on the specified port.
HandlerRegistrygetHandlerRegistry()
Returns the configured HandlerRegistry instance for this Service instance.
RemotegetPort(QName portName, Class serviceEndpointInterface)
The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.
RemotegetPort(Class serviceEndpointInterface)
The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.
IteratorgetPorts()
Returns an Iterator for the list of QNames of service endpoints grouped by this service.
QNamegetServiceName()
Gets the name of this Service.
TypeMappingRegistrygetTypeMappingRegistry()
Gets the TypeMappingRegistry for this Service object.
URLgetWSDLDocumentLocation()
Gets location of the WSDL document for this Service.

Method Detail

createCall

public Call createCall(QName portName)
Creates a Call instance.

Parameters: portName Qualified name for the target service endpoint

Returns: Call instance

Throws: ServiceException If any error in the creation of the Call object

createCall

public Call createCall(QName portName, QName operationName)
Creates a Call instance.

Parameters: portName Qualified name for the target service endpoint operationName Qualified Name of the operation for which this Call object is to be created.

Returns: Call instance

Throws: ServiceException If any error in the creation of the Call object

createCall

public Call createCall(QName portName, String operationName)
Creates a Call instance.

Parameters: portName Qualified name for the target service endpoint operationName Name of the operation for which this Call object is to be created.

Returns: Call instance

Throws: ServiceException If any error in the creation of the Call object

createCall

public Call createCall()
Creates a Call object not associated with specific operation or target service endpoint. This Call object needs to be configured using the setter methods on the Call interface.

Returns: Call object

Throws: ServiceException If any error in the creation of the Call object

getCalls

public Call[] getCalls(QName portName)
Gets an array of preconfigured Call objects for invoking operations on the specified port. There is one Call object per operation that can be invoked on the specified port. Each Call object is pre-configured and does not need to be configured using the setter methods on Call interface.

Each invocation of the getCalls method returns a new array of preconfigured Call objects

This method requires the Service implementation class to have access to the WSDL related metadata.

Parameters: portName Qualified name for the target service endpoint

Returns: Call[] Array of pre-configured Call objects

Throws: ServiceException If this Service class does not have access to the required WSDL metadata or if an illegal portName is specified.

getHandlerRegistry

public HandlerRegistry getHandlerRegistry()
Returns the configured HandlerRegistry instance for this Service instance.

Returns: HandlerRegistry

Throws: java.lang.UnsupportedOperationException - if the Service class does not support the configuration of a HandlerRegistry

getPort

public Remote getPort(QName portName, Class serviceEndpointInterface)
The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy. A service client uses this dynamic proxy to invoke operations on the target service endpoint. The serviceEndpointInterface specifies the service endpoint interface that is supported by the created dynamic proxy or stub instance.

Parameters: portName Qualified name of the service endpoint in the WSDL service description serviceEndpointInterface Service endpoint interface supported by the dynamic proxy or stub instance

Returns: java.rmi.Remote Stub instance or dynamic proxy that supports the specified service endpoint interface

Throws: ServiceException This exception is thrown in the following cases:

getPort

public Remote getPort(Class serviceEndpointInterface)
The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy. The parameter serviceEndpointInterface specifies the service endpoint interface that is supported by the returned stub or proxy. In the implementation of this method, the JAX-RPC runtime system takes the responsibility of selecting a protocol binding (and a port) and configuring the stub accordingly. The returned Stub instance should not be reconfigured by the client.

Parameters: serviceEndpointInterface Service endpoint interface

Returns: Stub instance or dynamic proxy that supports the specified service endpoint interface

Throws: ServiceException

getPorts

public Iterator getPorts()
Returns an Iterator for the list of QNames of service endpoints grouped by this service.

Returns: Returns java.util.Iterator with elements of type javax.xml.namespace.QName

Throws: ServiceException If this Service class does not have access to the required WSDL metadata

getServiceName

public QName getServiceName()
Gets the name of this Service.

Returns: Qualified name of this service

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()
Gets the TypeMappingRegistry for this Service object. The returned TypeMappingRegistry instance is pre-configured to support the standard type mapping between XML and Java types types as required by the JAX-RPC specification.

Returns: The TypeMappingRegistry for this Service object.

Throws: java.lang.UnsupportedOperationException if the Service class does not support the configuration of TypeMappingRegistry.

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()
Gets location of the WSDL document for this Service.

Returns: URL for the location of the WSDL document for this service