javax.xml.rpc
Interface Service

All Known Subinterfaces:

ExceptionService (src) , OrderProcessService (src) , OrganizationService (src)

All Known Implementing Classes:

Service (src)

public interface Service

Service class acts as a factory for:

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

getWSDLDocumentLocation

public java.net.URL getWSDLDocumentLocation()

Gets the location of the WSDL document for this Service.

Returns:

URL for the location of the WSDL document for this service

getPorts

public java.util.Iterator getPorts()
                            throws ServiceException (src) 

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 (src) - If this Service class does not have access to the required WSDL metadata

getServiceName

public QName (src)  getServiceName()

Gets the name of this service.

Returns:

Qualified name of this service

createCall

public Call (src)  createCall()
                throws ServiceException (src) 

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 (src) - If any error in the creation of the Call object

getTypeMappingRegistry

public TypeMappingRegistry (src)  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.

getHandlerRegistry

public HandlerRegistry (src)  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 java.rmi.Remote getPort(java.lang.Class seiClass)
                        throws ServiceException (src) 

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.

Throws:

ServiceException (src)

createCall

public Call (src)  createCall(QName (src)  portName)
                throws ServiceException (src) 

Creates a Call instance.

Parameters:

portName - Qualified name for the target service endpoint

Returns:

Call instance

Throws:

ServiceException (src) - If any error in the creation of the Call object

getCalls

public Call (src) [] getCalls(QName (src)  portName)
                throws ServiceException (src) 

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 (src) - If this Service class does not have access to the required WSDL metadata or if an illegal portName is specified.

getPort

public java.rmi.Remote getPort(QName (src)  portName,
                               java.lang.Class seiClass)
                        throws ServiceException (src) 

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 descr

seiClass - Service endpoint interface supported by the dynamic proxy or stub instance

Returns:

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

Throws:

ServiceException (src) - This exception is thrown in the following cases:

• If there is an error in creation of the dynamic proxy or stub instance
• If there is any missing WSDL metadata as required by this method
• Optionally, if an illegal serviceEndpointInterface or portName is specified

createCall

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

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 (src) - If any error in the creation of the Call object

createCall

public Call (src)  createCall(QName (src)  portName,
                       QName (src)  operationName)
                throws ServiceException (src) 

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 (src) - If any error in the creation of the Call object