com.wingfoot.soap
Class Call

java.lang.Object
  |
  +--com.wingfoot.soap.Call

public class Call
extends java.lang.Object

Entry point for making a SOAP call. The call could be a RPC style body or Document style body. This class is used to send a SOAP payload to the SOAP server.

Since:
0.90

Constructor Summary
Call()
          Default constructor.
Call(Envelope envelope)
          Constructor using a custom SOAP Envelope built by user.
 
Method Summary
 void addParameter(java.lang.String paramName, java.lang.Object value)
          Allows the user to specify the RPC style Parameter name and value.
 Envelope invoke(Transport transport)
          Call to serialize and send the soap payload to the server and get back the response.
 void setMappingRegistry(TypeMappingRegistry registry)
          Sets the registry to associate a Class with the serializer class, desserializer class and the name of the class.
 void setMethodName(java.lang.String methodName)
          Sets the name of the method to invoke on the server.
 void setTargetObjectURI(java.lang.String uri)
          Sets the URI of the service on the server.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Call

public Call()
Default constructor. Since no Envelope is specified, a default Envelope is created.
Since:
0.90

Call

public Call(Envelope envelope)
Constructor using a custom SOAP Envelope built by user. A custom Envelope is required if
Since:
0.90
Method Detail

addParameter

public void addParameter(java.lang.String paramName,
                         java.lang.Object value)
                  throws SOAPException
Allows the user to specify the RPC style Parameter name and value. This parameter name and value is sent to the service as part of the element of a SOAP message.
Parameters:
paramName - the name of the parameter.
value - the value of the parameter represented as a Java object. Primitive data types are represented by their corresponding wrapper classes.
Throws:
SOAPException - thrown if a Document style parameter was previously added.
Since:
0.90

setTargetObjectURI

public void setTargetObjectURI(java.lang.String uri)
Sets the URI of the service on the server. This is typically required only for a RPC style service.
Parameters:
uri - URI for the service on the server.
Since:
0.90

setMethodName

public void setMethodName(java.lang.String methodName)
Sets the name of the method to invoke on the server. This is typically required only for a RPC style service.
Parameters:
methodName - the name of the method to invoke on the service.
Since:
0.90

setMappingRegistry

public void setMappingRegistry(TypeMappingRegistry registry)
Sets the registry to associate a Class with the serializer class, desserializer class and the name of the class. The registry is useful in serialization and deserialization. This is typically required only for a RPC style service.
Parameters:
registry - instance of TypeMappingRegistry
Since:
0.90

invoke

public Envelope invoke(Transport transport)
                throws SOAPException,
                       java.lang.Exception
Call to serialize and send the soap payload to the server and get back the response. The response is encapsulated in Envelope
Parameters:
transport - an implementation of Transport interface. An instance of HTTPTransport is provided to use HTTP as the transport to communicate to the service on the server. Users can write their own Transport (example SMTP instead of HTTP).
Returns:
the response from the service encapsulated as an Envelope.
Since:
0.90


Copyright(c) Wingfoot Software (www.wingfoot.com). All Rights Reserved.

KXML is a XML parser by Lutris Technologies