|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.axis.client.Service
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.
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(EngineConfiguration engineConfiguration,
AxisClient axisClient)
Constructs a Service using the supplied configuration and engine directly. |
|
Service(java.io.InputStream wsdlInputStream,
QName serviceName)
Constructs a new Service object for the service in the WSDL document in the wsdlInputStream and serviceName parameters. |
|
Service(org.apache.axis.wsdl.gen.Parser parser,
QName serviceName)
Constructs a new Service object for the service in the WSDL document |
|
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(java.lang.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(java.net.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. |
Method Summary | |
Call |
createCall()
Creates a new Call object with no prefilled data. |
Call |
createCall(QName portName)
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(QName portName,
java.lang.String operationName)
Creates a new Call object - will prefill as much info from the WSDL as it can. |
boolean |
getCacheWSDL()
Tells whether or not we're caching WSDL |
Call |
getCall()
Deprecated. please use Stub._getCall |
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. |
HandlerRegistry |
getHandlerRegistry()
Returns the configured HandlerRegistry instance for this Service instance. |
boolean |
getMaintainSession()
If true, this service wants to track sessions. |
java.rmi.Remote |
getPort(java.lang.Class proxyInterface)
Return a dynamic proxy for the given proxy interface. |
java.rmi.Remote |
getPort(QName portName,
java.lang.Class proxyInterface)
Return either an instance of a generated stub, if it can be found, or a dynamic proxy for the given proxy interface. |
java.rmi.Remote |
getPort(java.lang.String endpoint,
java.lang.Class proxyInterface)
Return an object which acts as a dynamic proxy for the passed interface class. |
java.util.Iterator |
getPorts()
Returns an Iterator for the list of
QName s of service endpoints grouped by this
service |
javax.naming.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. |
java.net.URL |
getWSDLDocumentLocation()
Returns the location of the WSDL document used to prefill the data (if one was used at all). |
org.apache.axis.wsdl.gen.Parser |
getWSDLParser()
|
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(java.lang.String version)
Set the typemapping version |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public Service()
public Service(QName serviceName)
public Service(EngineConfiguration engineConfiguration, AxisClient axisClient)
engineConfiguration
- axisClient
- public Service(EngineConfiguration config)
public Service(java.net.URL wsdlDoc, QName serviceName) throws ServiceException
wsdlDoc
- URL of the WSDL documentserviceName
- Qualified name of the desired service
ServiceException
- If there's an error finding or parsing the WSDLpublic Service(org.apache.axis.wsdl.gen.Parser parser, QName serviceName) throws ServiceException
parser
- Parser for this serviceserviceName
- Qualified name of the desired service
ServiceException
- If there's an errorpublic Service(java.lang.String wsdlLocation, QName serviceName) throws ServiceException
wsdlLocation
- Location of the WSDL relative to the current dirserviceName
- Qualified name of the desired service
ServiceException
- If there's an error finding or parsing the WSDLpublic Service(java.io.InputStream wsdlInputStream, QName serviceName) throws ServiceException
wsdlInputStream
- InputStream containing the WSDLserviceName
- Qualified name of the desired service
ServiceException
- If there's an error finding or parsing the WSDLMethod Detail |
public org.apache.axis.wsdl.gen.Parser getWSDLParser()
public java.rmi.Remote getPort(QName portName, java.lang.Class proxyInterface) throws ServiceException
getPort
in interface Service
portName
- The name of the service portproxyInterface
- The Remote object returned by this
method will also implement the given proxyInterface
ServiceException
- If there's an errorpublic java.rmi.Remote getPort(java.lang.Class proxyInterface) throws ServiceException
getPort
in interface Service
proxyInterface
- The Remote object returned by this
method will also implement the given proxyInterface
ServiceException
- If there's an errorpublic java.rmi.Remote getPort(java.lang.String endpoint, java.lang.Class proxyInterface) throws ServiceException
endpoint
- the URL which will be used as the SOAP endpointproxyInterface
- the interface class which we wish to mimic
via a dynamic proxy
ServiceException
public Call createCall(QName portName) throws ServiceException
createCall
in interface Service
portName
- PortName in the WSDL doc to search for
ServiceException
- If there's an errorpublic Call createCall(QName portName, java.lang.String operationName) throws ServiceException
createCall
in interface Service
portName
- PortName in the WSDL doc to search foroperationName
- Operation(method) that's going to be invoked
ServiceException
- If there's an errorpublic Call createCall(QName portName, QName operationName) throws ServiceException
createCall
in interface Service
portName
- PortName in the WSDL doc to search foroperationName
- Operation(method) that's going to be invoked
ServiceException
- If there's an errorpublic Call createCall() throws ServiceException
createCall
in interface Service
ServiceException
- If there's an errorpublic Call[] getCalls(QName portName) throws ServiceException
getCalls
in interface Service
portName
- Qualified name for the target service endpoint
ServiceException
- - If this Service class does not have access
to the required WSDL metadata or if an illegal portName is specified.public HandlerRegistry getHandlerRegistry()
getHandlerRegistry
in interface Service
java.lang.UnsupportedOperationException
- - if the Service
class does not support the configuration of a
HandlerRegistry.public java.net.URL getWSDLDocumentLocation()
getWSDLDocumentLocation
in interface Service
public QName getServiceName()
getServiceName
in interface Service
public java.util.Iterator getPorts() throws ServiceException
Iterator
for the list of
QName
s of service endpoints grouped by this
service
getPorts
in interface 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 metadatapublic void setTypeMappingRegistry(TypeMappingRegistry registry) throws ServiceException
registry
- The TypeMappingRegistry
ServiceException
- if there's an errorpublic TypeMappingRegistry getTypeMappingRegistry()
getTypeMappingRegistry
in interface Service
public javax.naming.Reference getReference()
getReference
in interface javax.naming.Referenceable
public void setEngine(AxisEngine engine)
engine
- Sets this Service's AxisEngine to the passed in onepublic AxisEngine getEngine()
public void setEngineConfiguration(EngineConfiguration config)
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
.
config
- the EngineConfiguration we want to use.public void setMaintainSession(boolean yesno)
yesno
- true if session state is desired, false if not.public boolean getMaintainSession()
public Call getCall() throws ServiceException
ServiceException
public boolean getCacheWSDL()
public void setCacheWSDL(boolean flag)
public void setTypeMappingVersion(java.lang.String version)
version
-
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |