Package org.apache.cxf.transport.http

Class Servlet3ContinuationProvider.Servlet3Continuation

java.lang.Object

org.apache.cxf.transport.http.Servlet3ContinuationProvider.Servlet3Continuation

All Implemented Interfaces:

EventListener, javax.servlet.AsyncListener, Continuation

Direct Known Subclasses:

Servlet3ContinuationProvider.Servlet31Continuation

Enclosing class:

Servlet3ContinuationProvider

public class Servlet3ContinuationProvider.Servlet3Continuation
extends Object
implements Continuation, javax.servlet.AsyncListener

Constructor Summary

Constructors

Constructor	Description
Servlet3Continuation()

Method Summary

Modifier and Type	Method	Description
Object	getObject()	Get arbitrary object associated with the continuation for context
protected javax.servlet.ServletOutputStream	getOutputStream()
boolean	isNew()	Is this a newly created Continuation.
boolean	isPending()	Get the pending status
boolean	isReadyForWrite()
boolean	isResumed()	Get the resumed status
boolean	isTimeout()	Get the timeout status
void	onComplete(javax.servlet.AsyncEvent event)
void	onError(javax.servlet.AsyncEvent event)
void	onStartAsync(javax.servlet.AsyncEvent event)
void	onTimeout(javax.servlet.AsyncEvent event)
void	redispatch()
void	reset()	Reset the continuation
void	resume()	Resume a suspended request
void	setObject(Object o)	Sets arbitrary object associated with the continuation for context
boolean	suspend(long timeout)	This method will suspend the request for the timeout or until resume is called
protected void	updateMessageForSuspend()

Methods inherited from class java.lang.Object

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

Constructor Detail

Servlet3Continuation

public Servlet3Continuation()

Method Detail

suspend

public boolean suspend(long timeout)

Description copied from interface: Continuation

This method will suspend the request for the timeout or until resume is called

Specified by:

suspend in interface Continuation

Parameters:

timeout - the suspend timeout, timeout of 0 will suspend the request indefinitely.

Returns:

true if suspend was successful.

updateMessageForSuspend

protected void updateMessageForSuspend()

redispatch

public void redispatch()

resume

public void resume()

Description copied from interface: Continuation

Resume a suspended request

Specified by:

resume in interface Continuation

reset

public void reset()

Description copied from interface: Continuation

Reset the continuation

Specified by:

reset in interface Continuation

isNew

public boolean isNew()

Description copied from interface: Continuation

Is this a newly created Continuation.

Specified by:

isNew in interface Continuation

Returns:

true if the continuation has just been created and has not yet suspended the request.

isPending

public boolean isPending()

Description copied from interface: Continuation

Get the pending status

Specified by:

isPending in interface Continuation

Returns:

true if the continuation has been suspended.

isResumed

public boolean isResumed()

Description copied from interface: Continuation

Get the resumed status

Specified by:

isResumed in interface Continuation

Returns:

true if the continuation is has been resumed.

getObject

public Object getObject()

Description copied from interface: Continuation

Get arbitrary object associated with the continuation for context

Specified by:

getObject in interface Continuation

Returns:

An arbitrary object associated with the continuation

setObject

public void setObject(Object o)

Description copied from interface: Continuation

Sets arbitrary object associated with the continuation for context

Specified by:

setObject in interface Continuation

Parameters:

o - An arbitrary object to associate with the continuation

onComplete

public void onComplete(javax.servlet.AsyncEvent event)
                throws IOException

Specified by:

onComplete in interface javax.servlet.AsyncListener

Throws:

IOException

onError

public void onError(javax.servlet.AsyncEvent event)
             throws IOException

Specified by:

onError in interface javax.servlet.AsyncListener

Throws:

IOException

onStartAsync

public void onStartAsync(javax.servlet.AsyncEvent event)
                  throws IOException

Specified by:

onStartAsync in interface javax.servlet.AsyncListener

Throws:

IOException

onTimeout

public void onTimeout(javax.servlet.AsyncEvent event)
               throws IOException

Specified by:

onTimeout in interface javax.servlet.AsyncListener

Throws:

IOException

isReadyForWrite

public boolean isReadyForWrite()

Specified by:

isReadyForWrite in interface Continuation

getOutputStream

protected javax.servlet.ServletOutputStream getOutputStream()

isTimeout

public boolean isTimeout()

Description copied from interface: Continuation

Get the timeout status

Specified by:

isTimeout in interface Continuation

Returns:

true if the continuation is has been timeout.