org.jboss.axis.client
Class Service

java.lang.Object
  org.jboss.axis.client.Service

All Implemented Interfaces:

Serializable, Referenceable, javax.xml.rpc.Service

public class Service
extends Object
implements javax.xml.rpc.Service, Serializable, Referenceable

Axis' JAXRPC Dynamic Invoation Interface implementation of the Service interface.

The Service class should be used a the starting point for access SOAP Web Services. Typically, a Service will be created with a WSDL document and along with a serviceName you can then ask for a Call object that will allow you to invoke a Web Service.

Author:

Doug Davis (dug@us.ibm.com)

See Also:

Serialized Form

Nested Class Summary

protected static class

Service.HandlerRegistryImpl

Field Summary

protected static HashMap	cachedWSDL
protected static boolean	cachingWSDL
protected EngineConfiguration	config
protected AxisEngine	engine
protected javax.xml.namespace.QName	serviceName
protected String	wsdlLocation
protected javax.wsdl.Service	wsdlService

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(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(InputStream wsdlInputStream, javax.xml.namespace.QName serviceName)
Constructs a new Service object for the service in the WSDL document in the wsdlInputStream and serviceName parameters.

Service(Parser parser, javax.xml.namespace.QName serviceName)
Constructs a new Service object for the service in the WSDL document

Service(javax.xml.namespace.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(String wsdlLocation, javax.xml.namespace.QName serviceName)
Constructs a new Service object for the service in the WSDL document pointed to by the wsdlLocation and serviceName parameters.

Service(URL wsdlDoc, javax.xml.namespace.QName serviceName)
Constructs a new Service object for the service in the WSDL document pointed to by the wsdlDoc URL and serviceName parameters.

Method Summary

javax.xml.rpc.Call	createCall() Creates a new Call object with no prefilled data.
javax.xml.rpc.Call	createCall(javax.xml.namespace.QName portName) Creates a new Call object - will prefill as much info from the WSDL as it can.
javax.xml.rpc.Call	createCall(javax.xml.namespace.QName portName, javax.xml.namespace.QName operationName) Creates a new Call object - will prefill as much info from the WSDL as it can.
javax.xml.rpc.Call	createCall(javax.xml.namespace.QName portName, String operationName) Creates a new Call object - will prefill as much info from the WSDL as it can.
protected AxisClient	getAxisClient()
boolean	getCacheWSDL() Tells whether or not we're caching WSDL
javax.xml.rpc.Call[]	getCalls(javax.xml.namespace.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.
protected Remote	getGeneratedStub(javax.xml.namespace.QName portName, Class proxyInterface) With the proxyInterface and the service's portName, we have ALMOST enough info to find a generated stub.
javax.xml.rpc.handler.HandlerRegistry	getHandlerRegistry() Returns the configured HandlerRegistry instance for this Service instance.
boolean	getMaintainSession() If true, this service wants to track sessions.
protected Parser	getParser() Stub out, to give clients the cahnce to modify parser properties TDI 15-Jun-2004
Remote	getPort(Class proxyInterface) Return a dynamic proxy for the given proxy interface.
Remote	getPort(javax.xml.namespace.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(String endpoint, Class proxyInterface) Return an object which acts as a dynamic proxy for the passed interface class.
protected Remote	getPort(String endpoint, javax.xml.namespace.QName portName, Class proxyInterface)
Iterator	getPorts() Returns an Iterator for the list of QNames of service endpoints grouped by this service
Reference	getReference() Returns a reference to this object.
javax.xml.namespace.QName	getServiceName() Returns the qualified name of the service (if one is set).
protected String	getTargetEnpointAddress() The service may provide the target endpoint address, in case the client wsdl port does not contain a valid address.
javax.xml.rpc.encoding.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 javax.wsdl.Port	getWSDLPort(Class seiClass) Get the WSDL Port for a given service endpoint interface This implementation gets the wsdl port that corresponds to the class name, if not found it just get the first one we have.
protected javax.wsdl.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(javax.xml.rpc.encoding.TypeMappingRegistry registry) Defines the current Type Mappig Registry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

engine

protected transient AxisEngine engine

config

protected transient EngineConfiguration config

serviceName

protected javax.xml.namespace.QName serviceName

wsdlLocation

protected String wsdlLocation

wsdlService

protected javax.wsdl.Service wsdlService

cachedWSDL

protected static HashMap cachedWSDL

cachingWSDL

protected static boolean cachingWSDL

Constructor Detail

Service

public 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

public Service(javax.xml.namespace.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

public 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

public Service(URL wsdlDoc,
               javax.xml.namespace.QName serviceName)
        throws javax.xml.rpc.ServiceException

Constructs a new Service object for the service in the WSDL document pointed to by the wsdlDoc URL and serviceName parameters.

Parameters:

wsdlDoc - URL of the WSDL document

serviceName - Qualified name of the desired service

Throws:

javax.xml.rpc.ServiceException - If there's an error finding or parsing the WSDL

Service

public Service(Parser parser,
               javax.xml.namespace.QName serviceName)
        throws javax.xml.rpc.ServiceException

Constructs a new Service object for the service in the WSDL document

Parameters:

parser - Parser for this service

serviceName - Qualified name of the desired service

Throws:

javax.xml.rpc.ServiceException - If there's an error

Service

public Service(String wsdlLocation,
               javax.xml.namespace.QName serviceName)
        throws javax.xml.rpc.ServiceException

Constructs a new Service object for the service in the WSDL document pointed to by the wsdlLocation and serviceName parameters. This is just like the previous constructor but instead of URL the wsdlLocation parameter points to a file on the filesystem relative to the current directory.

Parameters:

wsdlLocation - Location of the WSDL relative to the current dir

serviceName - Qualified name of the desired service

Throws:

javax.xml.rpc.ServiceException - If there's an error finding or parsing the WSDL

Service

public Service(InputStream wsdlInputStream,
               javax.xml.namespace.QName serviceName)
        throws javax.xml.rpc.ServiceException

Constructs a new Service object for the service in the WSDL document in the wsdlInputStream and serviceName parameters. This is just like the previous constructor but instead of reading the WSDL from a file (or from a URL) it is in the passed in InputStream.

Parameters:

wsdlInputStream - InputStream containing the WSDL

serviceName - Qualified name of the desired service

Throws:

javax.xml.rpc.ServiceException - If there's an error finding or parsing the WSDL

Method Detail

getParser

protected Parser getParser()

Stub out, to give clients the cahnce to modify parser properties TDI 15-Jun-2004

getWSDLService

protected javax.wsdl.Service getWSDLService()

getWSDLParser

public Parser getWSDLParser()

getAxisClient

protected AxisClient getAxisClient()

getPort

public Remote getPort(javax.xml.namespace.QName portName,
                      Class proxyInterface)
               throws javax.xml.rpc.ServiceException

Return either an instance of a generated stub, if it can be found, or a dynamic proxy for the given proxy interface.

Specified by:

getPort in interface javax.xml.rpc.Service

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:

javax.xml.rpc.ServiceException - If there's an error

getGeneratedStub

protected Remote getGeneratedStub(javax.xml.namespace.QName portName,
                                  Class proxyInterface)
                           throws javax.xml.rpc.ServiceException

With the proxyInterface and the service's portName, we have ALMOST enough info to find a generated stub. The generated stub is named after the binding, which we can get from the service's port. This binding is likely in the same namespace (ie, package) that the proxyInterface is in. So try to find and instantiate .Stub. If it doesn't exist, return null.

Throws:

javax.xml.rpc.ServiceException

getPort

public Remote getPort(Class proxyInterface)
               throws javax.xml.rpc.ServiceException

Return a dynamic proxy for the given proxy interface.

Specified by:

getPort in interface javax.xml.rpc.Service

Parameters:

proxyInterface - The Remote object returned by this method will also implement the given proxyInterface

Returns:

java.rmi.Remote The stub implementation

Throws:

javax.xml.rpc.ServiceException - If there's an error

getWSDLPort

protected javax.wsdl.Port getWSDLPort(Class seiClass)
                               throws javax.xml.rpc.ServiceException

Get the WSDL Port for a given service endpoint interface

This implementation gets the wsdl port that corresponds to the class name, if not found it just get the first one we have.

Parameters:

seiClass - The service endpoint interface class

Returns:

A wsdl Port

Throws:

javax.xml.rpc.ServiceException - If there's an error

getPort

public Remote getPort(String endpoint,
                      Class proxyInterface)
               throws javax.xml.rpc.ServiceException

Return an object which acts as a dynamic proxy for the passed interface class. This is a more "dynamic" version in that it doesn't actually require WSDL, simply an endpoint address.

Note: Not part of the JAX-RPC spec.

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:

javax.xml.rpc.ServiceException

getPort

protected Remote getPort(String endpoint,
                         javax.xml.namespace.QName portName,
                         Class proxyInterface)
                  throws javax.xml.rpc.ServiceException

Throws:

javax.xml.rpc.ServiceException

createCall

public javax.xml.rpc.Call createCall(javax.xml.namespace.QName portName)
                              throws javax.xml.rpc.ServiceException

Creates a new Call object - will prefill as much info from the WSDL as it can. Right now it's just the target URL of the Web Service.

Specified by:

createCall in interface javax.xml.rpc.Service

Parameters:

portName - PortName in the WSDL doc to search for

Returns:

Call Used for invoking the Web Service

Throws:

javax.xml.rpc.ServiceException - If there's an error

getTargetEnpointAddress

protected String getTargetEnpointAddress()

The service may provide the target endpoint address, in case the client wsdl port does not contain a valid address. This maybe the case for ws4ee clients that use a port-component-link element.

createCall

public javax.xml.rpc.Call createCall(javax.xml.namespace.QName portName,
                                     String operationName)
                              throws javax.xml.rpc.ServiceException

Creates a new Call object - will prefill as much info from the WSDL as it can. Right now it's target URL, SOAPAction, Parameter types, and return type of the Web Service.

Specified by:

createCall in interface javax.xml.rpc.Service

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:

javax.xml.rpc.ServiceException - If there's an error

createCall

public javax.xml.rpc.Call createCall(javax.xml.namespace.QName portName,
                                     javax.xml.namespace.QName operationName)
                              throws javax.xml.rpc.ServiceException

Creates a new Call object - will prefill as much info from the WSDL as it can. Right now it's target URL, SOAPAction, Parameter types, and return type of the Web Service.

Specified by:

createCall in interface javax.xml.rpc.Service

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:

javax.xml.rpc.ServiceException - If there's an error

createCall

public javax.xml.rpc.Call createCall()
                              throws javax.xml.rpc.ServiceException

Creates a new Call object with no prefilled data. This assumes that the caller will set everything manually - no checking of any kind will be done against the WSDL.

Specified by:

createCall in interface javax.xml.rpc.Service

Returns:

Call Used for invoking the Web Service

Throws:

javax.xml.rpc.ServiceException - If there's an error

getCalls

public javax.xml.rpc.Call[] getCalls(javax.xml.namespace.QName portName)
                              throws javax.xml.rpc.ServiceException

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.

This method requires the Service implementation class to have access to the WSDL related metadata.

Specified by:

getCalls in interface javax.xml.rpc.Service

Throws:

javax.xml.rpc.ServiceException - - If this Service class does not have access to the required WSDL metadata or if an illegal portName is specified.

getHandlerRegistry

public javax.xml.rpc.handler.HandlerRegistry getHandlerRegistry()

Returns the configured HandlerRegistry instance for this Service instance.

NOTE: This Service currently does not support the configuration of a HandlerRegistry! It will throw a java.lang.UnsupportedOperationException.

Specified by:

getHandlerRegistry in interface javax.xml.rpc.Service

Returns:

HandlerRegistry

Throws:

UnsupportedOperationException - - if the Service class does not support the configuration of a HandlerRegistry.

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

Returns the location of the WSDL document used to prefill the data (if one was used at all).

Specified by:

getWSDLDocumentLocation in interface javax.xml.rpc.Service

Returns:

URL URL pointing to the WSDL doc

getServiceName

public javax.xml.namespace.QName getServiceName()

Returns the qualified name of the service (if one is set).

Specified by:

getServiceName in interface javax.xml.rpc.Service

Returns:

QName Fully qualified name of this service.

getPorts

public Iterator getPorts()
                  throws javax.xml.rpc.ServiceException

Returns an Iterator for the list of QNames of service endpoints grouped by this service

Specified by:

getPorts in interface javax.xml.rpc.Service

Returns:

Returns java.util.Iterator with elements of type javax.xml.namespace.QName

Throws:

javax.xml.rpc.ServiceException - If this Service class does not have access to the required WSDL metadata

setTypeMappingRegistry

public void setTypeMappingRegistry(javax.xml.rpc.encoding.TypeMappingRegistry registry)
                            throws javax.xml.rpc.ServiceException

Defines the current Type Mappig Registry.

Parameters:

registry - The TypeMappingRegistry

Throws:

javax.xml.rpc.ServiceException - if there's an error

getTypeMappingRegistry

public javax.xml.rpc.encoding.TypeMappingRegistry getTypeMappingRegistry()

Returns the current TypeMappingRegistry or null.

Specified by:

getTypeMappingRegistry in interface javax.xml.rpc.Service

Returns:

TypeMappingRegistry The registry

getReference

public Reference getReference()

Returns a reference to this object.

Specified by:

getReference in interface Referenceable

Returns:

Reference ...

setEngine

public void setEngine(AxisEngine engine)

Sets this Service's AxisEngine. This engine will be shared by all Call objects created from this Service object.

Note: Not part of the JAX-RPC spec.

Parameters:

engine - Sets this Service's AxisEngine to the passed in one

getEngine

public AxisEngine getEngine()

Returns the current AxisEngine used by this Service and all of the Call objects created from this Service object.

Note: Not part of the JAX-RPC spec.

Returns:

AxisEngine the engine

setEngineConfiguration

public void setEngineConfiguration(EngineConfiguration config)

Set this Service's engine configuration.

Note that since all of the constructors create the AxisClient right now, this is basically a no-op. Putting it in now so that we can make lazy engine instantiation work, and not have to duplicate every single Service constructor with a EngineConfiguration argument.

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
public static EngineConfigurationFactory newFactory(Object param) method. See 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.

getEngineConfiguration

protected EngineConfiguration getEngineConfiguration()

Constructs a EngineConfig if one is not available.

setMaintainSession

public void setMaintainSession(boolean yesno)

Determine whether we'd like to track sessions or not. This information is passed to all Call objects created from this service. Calling setMaintainSession will only affect future instantiations of the Call object, not those that already exist.

Note: Not part of JAX-RPC specification.

Parameters:

yesno - true if session state is desired, false if not.

getMaintainSession

public boolean getMaintainSession()

If true, this service wants to track sessions.

getCacheWSDL

public boolean getCacheWSDL()

Tells whether or not we're caching WSDL

setCacheWSDL

public void setCacheWSDL(boolean flag)

Allows users to turn caching of WSDL documents on or off. Default is 'true' (on).