public interface Service
Service
class acts as a factory of the following:
javax.xml.rpc.Call
for
the dynamic invocation of a remote operation on the
target service endpoint.
Modifier and Type | Method and Description |
---|---|
Call |
createCall()
Creates a
Call object not associated with
specific operation or target service endpoint. |
Call |
createCall(QName portName)
Creates a
Call instance. |
Call |
createCall(QName portName,
QName operationName)
Creates a
Call instance. |
Call |
createCall(QName portName,
String operationName)
Creates a
Call instance. |
Call[] |
getCalls(QName portName)
Gets an array of preconfigured
Call objects for
invoking operations on the specified port. |
HandlerRegistry |
getHandlerRegistry()
Returns the configured
HandlerRegistry instance
for this Service instance. |
Remote |
getPort(Class serviceEndpointInterface)
The getPort method returns either an instance of a generated
stub implementation class or a dynamic proxy.
|
Remote |
getPort(QName portName,
Class serviceEndpointInterface)
The getPort method returns either an instance of a generated
stub implementation class or a dynamic proxy.
|
Iterator |
getPorts()
Returns an
Iterator for the list of
QName s of service endpoints grouped by this
service. |
QName |
getServiceName()
Gets the name of this Service.
|
TypeMappingRegistry |
getTypeMappingRegistry()
Gets the
TypeMappingRegistry for this
Service object. |
URL |
getWSDLDocumentLocation()
Gets location of the WSDL document for this Service.
|
Remote getPort(QName portName, Class serviceEndpointInterface) throws ServiceException
serviceEndpointInterface
specifies the service endpoint interface that is supported by
the created dynamic proxy or stub instance.portName
- Qualified name of the service endpoint in
the WSDL service descriptionserviceEndpointInterface
- Service endpoint interface
supported by the dynamic proxy or stub
instanceServiceException
- This exception is thrown in the
following cases:
serviceEndpointInterface
or portName
is specified
Remote getPort(Class serviceEndpointInterface) throws ServiceException
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.serviceEndpointInterface
- Service endpoint interfaceServiceException
- serviceEndpointInterface
is specified
Call[] getCalls(QName portName) throws ServiceException
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.
portName
- Qualified name for the target service endpointServiceException
- If this Service class does not
have access to the required WSDL metadata
or if an illegal portName
is
specified.Call createCall(QName portName) throws ServiceException
Call
instance.portName
- Qualified name for the target service endpointServiceException
- If any error in the creation of
the Call
objectCall createCall(QName portName, QName operationName) throws ServiceException
Call
instance.portName
- Qualified name for the target service
endpointoperationName
- Qualified Name of the operation for
which this Call
object is to
be created.ServiceException
- If any error in the creation of
the Call
objectCall createCall(QName portName, String operationName) throws ServiceException
Call
instance.portName
- Qualified name for the target service
endpointoperationName
- Name of the operation for which this
Call
object is to be
created.ServiceException
- If any error in the creation of
the Call
objectCall createCall() throws ServiceException
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.ServiceException
- If any error in the creation of
the Call
objectQName getServiceName()
Iterator getPorts() throws ServiceException
Iterator
for the list of
QName
s of service endpoints grouped by this
service.java.util.Iterator
with elements
of type javax.xml.namespace.QName
ServiceException
- If this Service class does not
have access to the required WSDL metadataURL getWSDLDocumentLocation()
TypeMappingRegistry getTypeMappingRegistry()
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.UnsupportedOperationException
- if the Service
class does not support
the configuration of TypeMappingRegistry
.HandlerRegistry getHandlerRegistry()
HandlerRegistry
instance
for this Service
instance.UnsupportedOperationException
- - if the Service
class does not support
the configuration of a HandlerRegistry
Copyright © The Apache Software Foundation. All Rights Reserved.