Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIWebServiceProxyFactory Interface Reference

import "nsIWebServiceProxy.idl";

Inheritance diagram for nsIWebServiceProxyFactory:
Inheritance graph
[legend]
Collaboration diagram for nsIWebServiceProxyFactory:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsIWebServiceProxy createProxy (in AString wsdlURL, in AString portname, in AString qualifier, in boolean isAsync)
 Create a service proxy.
void createProxyAsync (in AString wsdlURL, in AString portname, in AString qualifier, in boolean isAsync, in nsIWebServiceProxyCreationListener listener)
 Create a service proxy.

Detailed Description

Definition at line 54 of file nsIWebServiceProxy.idl.


Member Function Documentation

nsIWebServiceProxy nsIWebServiceProxyFactory::createProxy ( in AString  wsdlURL,
in AString  portname,
in AString  qualifier,
in boolean  isAsync 
)

Create a service proxy.

Loading of the WSDL URL will occur in a synchronous manner. Calls to web service can be made as soon as this method completes.

Parameters:
wsdlURLThe URL of the WSDL service description. This description will be loaded and used as the basis for the service proxy.
portnameThe name of the port of the service that this service proxy represents. Currently the port must represent a SOAP binding.
qualifierThe user-specified qualifier is incorporated into the names of XPCOM interfaces created for the service proxy. For C++ callers, this qualifier should be the same one used in creating the IDL used at compile time. Script callers need not specify a qualifier.
isAsyncIf PR_TRUE, the method signatures of the service proxy represent an asynchronous calling convention. A callback instance must be registered with the proxy. A method call to a web service is only completed when the corresponding callback method is invoked. If PR_FALSE, the method signatures of the service proxy represent a synchronous callling convention. A method call to a web service is completed when the method call to the proxy returns.
void nsIWebServiceProxyFactory::createProxyAsync ( in AString  wsdlURL,
in AString  portname,
in AString  qualifier,
in boolean  isAsync,
in nsIWebServiceProxyCreationListener  listener 
)

Create a service proxy.

Loading of the WSDL URL will occur in an asynchronous manner. Methods on the listener instance will be invoked when the proxy has been created. Any method invocations on the service proxy prior to asynchronous completion of the intialization step will fail. The caller is guaranteed that this method will return before the listener is invoked.

Parameters:
wsdlURLThe URL of the WSDL service description. This description will be loaded and used as the basis for the service proxy.
portnameThe name of the port of the service that this service proxy represents. Currently the port must represent a SOAP binding.
qualifierThe user-specified qualifier is incorporated into the names of XPCOM interfaces created for the service proxy. For C++ callers, this qualifier should be the same one used in creating the IDL used at compile time. Script callers need not specify a qualifier.
isAsyncIf PR_TRUE, the method signatures of the service proxy represent an asynchronous calling convention. A callback instance must be registered with the proxy. A method call to a web service is only completed when the corresponding callback method is invoked. If PR_FALSE, the method signatures of the service proxy represent a synchronous callling convention. A method call to a web service is completed when the method call to the proxy returns.
listenerThe callback instance which will be invoked when the proxy is completely initialized.

The documentation for this interface was generated from the following file: