Servlet3ContinuationProvider.Servlet3Continuation (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.transport.http.Servlet3ContinuationProvider.Servlet3Continuation

All Implemented Interfaces:: EventListener, javax.servlet.AsyncListener, Continuation

Enclosing class:: Servlet3ContinuationProvider

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

Constructor Summary

Constructors
Constructor and Description

Servlet3ContinuationProvider.Servlet3Continuation()

Constructors
Constructor and Description
`Servlet3ContinuationProvider.Servlet3Continuation()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`getObject()` Get arbitrary object associated with the continuation for context
`boolean`	`isNew()` Is this a newly created Continuation.
`boolean`	`isPending()` Get the pending status
`boolean`	`isResumed()` Get the resumed 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

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Servlet3ContinuationProvider.Servlet3Continuation
```
public Servlet3ContinuationProvider.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 - A timeout of < 0 will cause an immediate return. A timeout of 0 will wait indefinitely.
    
    Returns:
    True if resume called or false if timeout.
  - 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

Class Servlet3ContinuationProvider.Servlet3Continuation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Servlet3ContinuationProvider.Servlet3Continuation

Method Detail

suspend

redispatch

resume

reset

isNew

isPending

isResumed

getObject

setObject

onComplete

onError

onStartAsync

onTimeout