Package org.apache.xmlrpc.client

Class TimingOutCallback

java.lang.Object

org.apache.xmlrpc.client.TimingOutCallback

All Implemented Interfaces:

AsyncCallback

public class TimingOutCallback
extends Object
implements AsyncCallback

A callback object that can wait up to a specified amount of time for the XML-RPC response. Suggested use is as follows:

   // Wait for 10 seconds.
   TimingOutCallback callback = new TimingOutCallback(10 * 1000);
   XmlRpcClient client = new XmlRpcClient(url);
   client.executeAsync(methodName, aVector, callback);
   try {
       return callback.waitForResponse();
   } catch (TimeoutException e) {
       System.out.println("No response from server.");
   } catch (Exception e) {
       System.out.println("Server returned an error message.");
   }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimingOutCallback.TimeoutException	This exception is thrown, if the request times out.

Field Summary

Fields

Modifier and Type	Field	Description
private Throwable	error
private boolean	responseSeen
private Object	result
private final long	timeout

Constructor Summary

Constructors

Constructor	Description
TimingOutCallback(long pTimeout)	Waits the specified number of milliseconds for a response.

Method Summary

Modifier and Type	Method	Description
void	handleError(XmlRpcRequest pRequest, Throwable pError)	Something went wrong, handle error.
void	handleResult(XmlRpcRequest pRequest, Object pResult)	Call went ok, handle result.
Object	waitForResponse()	Called to wait for the response.

Methods inherited from class java.lang.Object

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

Field Details

timeout

private final long timeout

result

private Object result

error

private Throwable error

responseSeen

private boolean responseSeen

Constructor Details

TimingOutCallback

public TimingOutCallback(long pTimeout)

Waits the specified number of milliseconds for a response.

Method Details

waitForResponse

public Object waitForResponse()
                       throws Throwable

Called to wait for the response.

Throws:

InterruptedException - The thread was interrupted.

TimingOutCallback.TimeoutException - No response was received after waiting the specified time.

Throwable - An error was returned by the server.

handleError

public void handleError(XmlRpcRequest pRequest,
 Throwable pError)

Description copied from interface: AsyncCallback

Something went wrong, handle error.

Specified by:

handleError in interface AsyncCallback

Parameters:

pRequest - The request being performed.

pError - The error being thrown.

handleResult

public void handleResult(XmlRpcRequest pRequest,
 Object pResult)

Description copied from interface: AsyncCallback

Call went ok, handle result.

Specified by:

handleResult in interface AsyncCallback

Parameters:

pRequest - The request being performed.

pResult - The result object, which was returned by the server.