Package javax.xml.rpc
Interface Service
- All Known Implementing Classes:
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
-
Method Summary
Modifier and TypeMethodDescriptionCreates aCall
object not associated with specific operation or target service endpoint.createCall
(QName portName) Creates aCall
instance.createCall
(QName portName, String operationName) Creates aCall
instance.createCall
(QName portName, QName operationName) Creates aCall
instance.Call[]
Gets an array of preconfiguredCall
objects for invoking operations on the specified port.Returns the configuredHandlerRegistry
instance for thisService
instance.The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy.getPorts()
Returns anIterator
for the list ofQName
s of service endpoints grouped by this service.Gets the name of this Service.Gets theTypeMappingRegistry
for thisService
object.Gets location of the WSDL document for this Service.
-
Method Details
-
getPort
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. TheserviceEndpointInterface
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 descriptionserviceEndpointInterface
- 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:- 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
orportName
is specified
-
getPort
The getPort method returns either an instance of a generated stub implementation class or a dynamic proxy. The parameterserviceEndpointInterface
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 returnedStub
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
-- 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
-
getCalls
Gets an array of preconfiguredCall
objects for invoking operations on the specified port. There is oneCall
object per operation that can be invoked on the specified port. EachCall
object is pre-configured and does not need to be configured using the setter methods onCall
interface.Each invocation of the
getCalls
method returns a new array of preconfiguredCall
objectsThis 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 illegalportName
is specified.
-
createCall
Creates aCall
instance.- Parameters:
portName
- Qualified name for the target service endpoint- Returns:
- Call instance
- Throws:
ServiceException
- If any error in the creation of theCall
object
-
createCall
Creates aCall
instance.- Parameters:
portName
- Qualified name for the target service endpointoperationName
- Qualified Name of the operation for which thisCall
object is to be created.- Returns:
- Call instance
- Throws:
ServiceException
- If any error in the creation of theCall
object
-
createCall
Creates aCall
instance.- Parameters:
portName
- Qualified name for the target service endpointoperationName
- Name of the operation for which thisCall
object is to be created.- Returns:
- Call instance
- Throws:
ServiceException
- If any error in the creation of theCall
object
-
createCall
Creates aCall
object not associated with specific operation or target service endpoint. ThisCall
object needs to be configured using the setter methods on theCall
interface.- Returns:
- Call object
- Throws:
ServiceException
- If any error in the creation of theCall
object
-
getServiceName
QName getServiceName()Gets the name of this Service.- Returns:
- Qualified name of this service
-
getPorts
Returns anIterator
for the list ofQName
s of service endpoints grouped by this service.- Returns:
- Returns
java.util.Iterator
with elements of typejavax.xml.namespace.QName
- Throws:
ServiceException
- If this Service class does not have access to the required WSDL metadata
-
getWSDLDocumentLocation
URL getWSDLDocumentLocation()Gets location of the WSDL document for this Service.- Returns:
- URL for the location of the WSDL document for this service
-
getTypeMappingRegistry
TypeMappingRegistry getTypeMappingRegistry()Gets theTypeMappingRegistry
for thisService
object. The returnedTypeMappingRegistry
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:
UnsupportedOperationException
- if theService
class does not support the configuration ofTypeMappingRegistry
.
-
getHandlerRegistry
HandlerRegistry getHandlerRegistry()Returns the configuredHandlerRegistry
instance for thisService
instance.- Returns:
- HandlerRegistry
- Throws:
UnsupportedOperationException
- - if theService
class does not support the configuration of aHandlerRegistry
-