org.apache.axis2.jaxws.client.async

Class AsyncResponse

java.lang.Object

org.apache.axis2.jaxws.client.async.AsyncResponse

All Implemented Interfaces:

java.util.concurrent.Future, javax.xml.ws.Response

Direct Known Subclasses:

JAXBDispatchAsyncListener, ProxyAsyncListener, XMLDispatchAsyncListener

public abstract class AsyncResponse
extends java.lang.Object
implements javax.xml.ws.Response

The AsyncResponse class is used to collect the response information from Axis2 and deliver it to a JAX-WS client. AsyncResponse implements the javax.xml.ws.Response API that is defined in the JAX-WS 2.0 specification. The Response object will contain both the object that is returned as the response along with a java.util.Map with the context information of the response.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncResponse(EndpointDescription ed)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	cancel(boolean mayInterruptIfRunning)
java.lang.Object	get()
java.lang.Object	get(long timeout, java.util.concurrent.TimeUnit unit)
java.util.Map	getContext()
abstract java.lang.Throwable	getFaultResponse(MessageContext mc)
abstract java.lang.Object	getResponseValueObject(MessageContext mc)
boolean	isCancelled()
boolean	isDone()
protected void	onComplete(MessageContext mc)
protected void	onComplete(MessageContext mc, java.lang.ClassLoader cl)
protected void	onError(java.lang.Throwable flt, MessageContext faultCtx)
protected void	onError(java.lang.Throwable flt, MessageContext mc, java.lang.ClassLoader cl)

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncResponse

protected AsyncResponse(EndpointDescription ed)

Method Detail

onError

protected void onError(java.lang.Throwable flt,
           MessageContext mc,
           java.lang.ClassLoader cl)

onError

protected void onError(java.lang.Throwable flt,
           MessageContext faultCtx)

Parameters:

flt - Throwable fault that occurred

faultCtx - MessageContext if fault is a SOAP Fault

onComplete

protected void onComplete(MessageContext mc,
              java.lang.ClassLoader cl)

onComplete

protected void onComplete(MessageContext mc)

cancel

public boolean cancel(boolean mayInterruptIfRunning)

Specified by:

cancel in interface java.util.concurrent.Future

get

public java.lang.Object get()
                     throws java.lang.InterruptedException,
                            java.util.concurrent.ExecutionException

Specified by:

get in interface java.util.concurrent.Future

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

get

public java.lang.Object get(long timeout,
                   java.util.concurrent.TimeUnit unit)
                     throws java.lang.InterruptedException,
                            java.util.concurrent.ExecutionException,
                            java.util.concurrent.TimeoutException

Specified by:

get in interface java.util.concurrent.Future

Throws:

java.lang.InterruptedException

java.util.concurrent.ExecutionException

java.util.concurrent.TimeoutException

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface java.util.concurrent.Future

isDone

public boolean isDone()

Specified by:

isDone in interface java.util.concurrent.Future

getContext

public java.util.Map getContext()

Specified by:

getContext in interface javax.xml.ws.Response

getResponseValueObject

public abstract java.lang.Object getResponseValueObject(MessageContext mc)

getFaultResponse

public abstract java.lang.Throwable getFaultResponse(MessageContext mc)