org.apache.axis.client
public class Service extends Object implements Service, Serializable, Referenceable
Nested Class Summary | |
---|---|
protected static class | Service.HandlerRegistryImpl |
Field Summary | |
---|---|
protected Call | _call |
Constructor Summary | |
---|---|
Service()
Constructs a new Service object - this assumes the caller will set
the appropriate fields by hand rather than getting them from the
WSDL. | |
Service(QName serviceName)
Constructs a new Service object - this assumes the caller will set
the appropriate fields by hand rather than getting them from the
WSDL. | |
Service(EngineConfiguration engineConfiguration, AxisClient axisClient)
Constructs a Service using the supplied configuration and engine directly.
| |
Service(EngineConfiguration config)
Constructs a new Service object as above, but also passing in
the EngineConfiguration which should be used to set up the
AxisClient. | |
Service(URL wsdlDoc, QName serviceName)
Constructs a new Service object for the service in the WSDL document
pointed to by the wsdlDoc URL and serviceName parameters.
| |
Service(Parser parser, QName serviceName)
Constructs a new Service object for the service in the WSDL document
| |
Service(String wsdlLocation, QName serviceName)
Constructs a new Service object for the service in the WSDL document
pointed to by the wsdlLocation and serviceName parameters. | |
Service(InputStream wsdlInputStream, QName serviceName)
Constructs a new Service object for the service in the WSDL document
in the wsdlInputStream and serviceName parameters. |
Method Summary | |
---|---|
Call | createCall(QName portName)
Creates a new Call object - will prefill as much info from the WSDL
as it can. |
Call | createCall(QName portName, String operationName)
Creates a new Call object - will prefill as much info from the WSDL
as it can. |
Call | createCall(QName portName, QName operationName)
Creates a new Call object - will prefill as much info from the WSDL
as it can. |
Call | createCall()
Creates a new Call object with no prefilled data. |
protected AxisClient | getAxisClient() |
boolean | getCacheWSDL()
Tells whether or not we're caching WSDL |
Call | getCall()
Returns last Call object associated with this service. |
Call[] | getCalls(QName portName)
Gets an array of preconfigured Call objects for invoking operations
on the specified port. |
AxisEngine | getEngine()
Returns the current AxisEngine used by this Service and all of the
Call objects created from this Service object.
|
protected EngineConfiguration | getEngineConfiguration()
Constructs a EngineConfig if one is not available. |
HandlerRegistry | getHandlerRegistry()
Returns the configured HandlerRegistry instance for this Service
instance.
|
boolean | getMaintainSession()
If true, this service wants to track sessions. |
Remote | getPort(QName portName, Class proxyInterface)
Return either an instance of a generated stub, if it can be
found, or a dynamic proxy for the given proxy interface.
|
Remote | getPort(Class proxyInterface)
Return a dynamic proxy for the given proxy interface.
|
Remote | getPort(String endpoint, Class proxyInterface)
Return an object which acts as a dynamic proxy for the passed
interface class. |
Iterator | getPorts()
Returns an Iterator for the list of
QName s of service endpoints grouped by this
service
|
Reference | getReference()
Returns a reference to this object.
|
QName | getServiceName()
Returns the qualified name of the service (if one is set).
|
TypeMappingRegistry | getTypeMappingRegistry()
Returns the current TypeMappingRegistry or null.
|
URL | getWSDLDocumentLocation()
Returns the location of the WSDL document used to prefill the data
(if one was used at all).
|
Parser | getWSDLParser() |
protected Service | getWSDLService() |
void | setCacheWSDL(boolean flag)
Allows users to turn caching of WSDL documents on or off.
|
void | setEngine(AxisEngine engine)
Sets this Service's AxisEngine. |
void | setEngineConfiguration(EngineConfiguration config)
Set this Service's engine configuration.
|
void | setMaintainSession(boolean yesno)
Determine whether we'd like to track sessions or not.
|
void | setTypeMappingRegistry(TypeMappingRegistry registry)
Defines the current Type Mappig Registry.
|
void | setTypeMappingVersion(String version)
Set the typemapping version |
Parameters: engineConfiguration axisClient
Parameters: wsdlDoc URL of the WSDL document serviceName Qualified name of the desired service
Throws: ServiceException If there's an error finding or parsing the WSDL
Parameters: parser Parser for this service serviceName Qualified name of the desired service
Throws: ServiceException If there's an error
Parameters: wsdlLocation Location of the WSDL relative to the current dir serviceName Qualified name of the desired service
Throws: ServiceException If there's an error finding or parsing the WSDL
Parameters: wsdlInputStream InputStream containing the WSDL serviceName Qualified name of the desired service
Throws: ServiceException If there's an error finding or parsing the WSDL
Parameters: portName PortName in the WSDL doc to search for
Returns: Call Used for invoking the Web Service
Throws: ServiceException If there's an error
Parameters: portName PortName in the WSDL doc to search for operationName Operation(method) that's going to be invoked
Returns: Call Used for invoking the Web Service
Throws: ServiceException If there's an error
Parameters: portName PortName in the WSDL doc to search for operationName Operation(method) that's going to be invoked
Returns: Call Used for invoking the Web Service
Throws: ServiceException If there's an error
Returns: Call Used for invoking the Web Service
Throws: ServiceException If there's an error
Deprecated: please use Stub._getCall
Returns last Call object associated with this service. Note that since the Service is not thread-safe, you may not get the last call object that you created on this thread. please use Stub._getCallThrows: ServiceException - If this Service class does not have access to the required WSDL metadata or if an illegal portName is specified.
Returns: AxisEngine the engine
Returns: HandlerRegistry
Throws: java.lang.UnsupportedOperationException - if the Service class does not support the configuration of a HandlerRegistry.
Parameters: portName The name of the service port proxyInterface The Remote object returned by this method will also implement the given proxyInterface
Returns: java.rmi.Remote The stub implementation.
Throws: ServiceException If there's an error
Parameters: proxyInterface The Remote object returned by this method will also implement the given proxyInterface
Returns: java.rmi.Remote The stub implementation
Throws: ServiceException If there's an error
Parameters: endpoint the URL which will be used as the SOAP endpoint proxyInterface the interface class which we wish to mimic via a dynamic proxy
Throws: ServiceException
Iterator
for the list of
QName
s 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
Returns: Reference ...
Returns: QName Fully qualified name of this service.
Returns: TypeMappingRegistry The registry
Returns: URL URL pointing to the WSDL doc
Parameters: engine Sets this Service's AxisEngine to the passed in one
If you need to use a non-default EngineConfiguration
, do
the following before calling the Service constructor:
AxisProperties.setProperty(EngineConfigurationFactory.SYSTEM_PROPERTY_NAME,
"classname.of.new.EngineConfigurationFactory");
Where the second parameter is the name of your new class that implements
EngineConfigurationFactory
and a
method. See
public static EngineConfigurationFactory newFactory(Object param)
EngineConfigurationFactoryDefault
for an example
of how to do this.
This way, when the Service class constructor calls
EngineConfigurationFactoryFinder.newFactory().getClientEngineConfig()
the getClientEngineConfig() of your own EngineConfigurationFactory will be
called, and your configuration will be used in the constructed Service object.
Another way is to use the "discovery" method of
EngineConfigurationFactoryFinder
.
Parameters: config the EngineConfiguration we want to use.
Parameters: yesno true if session state is desired, false if not.
Parameters: registry The TypeMappingRegistry
Throws: ServiceException if there's an error
Parameters: version