org.controlhaus.xfire.client
Interface XFireClientControl

All Known Implementing Classes:
XFireClientControlBean, XFireClientControlImpl

public interface XFireClientControl

An XFire client control. Included are two annotations which can be used to configure the control. Encoding, which will specify the encoding. It defaults to UTF-8. Also the ServiceUrl annotation will specify which url to invoke for the service.

A typical usage would look like so:

  @Encoding("UTF-8")
  @ServiceUrl("http://some.service.com")
  @Control XFireClientControl client;
 

It is possible to set the service url on a per invocation basis if you declare the control "Bean" instead of just XFireClientControl. For example in your class you would declare,

 @Control XFireClientControlBean xfire;
 

You could then set the URL like so:

 xfire.setServiceUrl("http://your/url");
 

Since:
Nov 5, 2004
Author:
Dan Diephouse

Nested Class Summary
static interface XFireClientControl.Asynchronous
          Marks a method on a control which extends the XFireClientControl as ansynchronous.
static interface XFireClientControl.Encoding
           
static interface XFireClientControl.EndInvokeCallback
           
static interface XFireClientControl.ServiceUrl
           
static interface XFireClientControl.SoapHeader
          Declares a parameter in an control a Soap Header in a control which extends the XFireClientControl.
 
Method Summary
 void beginInvoke(org.apache.xmlbeans.XmlObject[] request, org.apache.xmlbeans.XmlObject[] reqHeaders)
          Invoke a SOAP service.
 org.apache.xmlbeans.XmlObject[] invoke(org.apache.xmlbeans.XmlObject[] request)
          Invoke a SOAP service.
 org.apache.xmlbeans.XmlObject[] invoke(org.apache.xmlbeans.XmlObject[] request, org.apache.xmlbeans.XmlObject[] reqHeaders)
          Invoke a SOAP service.
 

Method Detail

invoke

org.apache.xmlbeans.XmlObject[] invoke(org.apache.xmlbeans.XmlObject[] request)
                                       throws java.io.IOException,
                                              org.codehaus.xfire.fault.XFireFault
Invoke a SOAP service.

Parameters:
request - The request as XMLBeans.
Returns:
The response as XMLBeans.
Throws:
org.codehaus.xfire.fault.XFireFault
java.io.IOException

invoke

org.apache.xmlbeans.XmlObject[] invoke(org.apache.xmlbeans.XmlObject[] request,
                                       org.apache.xmlbeans.XmlObject[] reqHeaders)
                                       throws java.io.IOException,
                                              org.codehaus.xfire.fault.XFireFault
Invoke a SOAP service.

Parameters:
request - The request as XMLBeans.
requestHeaders - The SOAP Headers, if there are any. Otherwise null.
Returns:
The response as XMLBeans.
Throws:
org.codehaus.xfire.fault.XFireFault
java.io.IOException

beginInvoke

void beginInvoke(org.apache.xmlbeans.XmlObject[] request,
                 org.apache.xmlbeans.XmlObject[] reqHeaders)
Invoke a SOAP service. Listen for the response using the Control's Event mechanism.

Parameters:
request - The request as XMLBeans.
requestHeaders - The SOAP Headers, if there are any. Otherwise null.
Throws:
org.codehaus.xfire.fault.XFireFault


Copyright © 2004-2005 Controlhaus. All Rights Reserved.