FileDocCategorySizeDatePackage
Service.javaAPI DocApache Axis 1.48907Sat Apr 22 18:57:28 BST 2006javax.xml.rpc

Service

public interface Service
Service class acts as a factory of the following:
  • 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
version
1.0

Fields Summary
Constructors Summary
Methods Summary
public CallcreateCall(javax.xml.namespace.QName portName)
Creates a Call instance.

param
portName Qualified name for the target service endpoint
return
Call instance
throws
ServiceException If any error in the creation of the Call object

public CallcreateCall(javax.xml.namespace.QName portName, javax.xml.namespace.QName operationName)
Creates a Call instance.

param
portName Qualified name for the target service endpoint
param
operationName Qualified Name of the operation for which this Call object is to be created.
return
Call instance
throws
ServiceException If any error in the creation of the Call object

public CallcreateCall(javax.xml.namespace.QName portName, java.lang.String operationName)
Creates a Call instance.

param
portName Qualified name for the target service endpoint
param
operationName Name of the operation for which this Call object is to be created.
return
Call instance
throws
ServiceException If any error in the creation of the Call object

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

return
Call object
throws
ServiceException If any error in the creation of the Call object

public Call[]getCalls(javax.xml.namespace.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.

param
portName Qualified name for the target service endpoint
return
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.

public javax.xml.rpc.handler.HandlerRegistrygetHandlerRegistry()
Returns the configured HandlerRegistry instance for this Service instance.

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

public java.rmi.RemotegetPort(javax.xml.namespace.QName portName, java.lang.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.

param
portName Qualified name of the service endpoint in the WSDL service description
param
serviceEndpointInterface Service endpoint interface supported by the dynamic proxy or stub instance
return
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:
  • 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

public java.rmi.RemotegetPort(java.lang.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.

param
serviceEndpointInterface Service endpoint interface
return
Stub instance or dynamic proxy that supports the specified service endpoint interface
throws
ServiceException
  • If there is an error during creation of stub instance or dynamic proxy
  • If there is any missing WSDL metadata as required by this method
  • Optionally, if an illegal serviceEndpointInterface is specified

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

return
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

public javax.xml.namespace.QNamegetServiceName()
Gets the name of this Service.

return
Qualified name of this service

public javax.xml.rpc.encoding.TypeMappingRegistrygetTypeMappingRegistry()
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.

return
The TypeMappingRegistry for this Service object.
throws
java.lang.UnsupportedOperationException if the Service class does not support the configuration of TypeMappingRegistry.

public java.net.URLgetWSDLDocumentLocation()
Gets location of the WSDL document for this Service.

return
URL for the location of the WSDL document for this service