AbstractServerHttpExchange (Vibe Platform/HTTP 3.0.0-Alpha7 API)

java.lang.Object
- org.atmosphere.vibe.platform.http.AbstractServerHttpExchange

All Implemented Interfaces:

ServerHttpExchange
```
public abstract class AbstractServerHttpExchange
extends Object
implements ServerHttpExchange
```
Abstract base class for ServerHttpExchange.

Author:

Donghwan Kim

Field Summary

Fields
Modifier and Type Field and Description

protected Actions<Void> closeActions

protected Actions<Void> endActions

protected Actions<Throwable> errorActions

Fields
Modifier and Type	Field and Description
`protected Actions<Void>`	`closeActions`
`protected Actions<Void>`	`endActions`
`protected Actions<Throwable>`	`errorActions`

Constructor Summary

Constructors
Constructor and Description

AbstractServerHttpExchange()

Constructors
Constructor and Description
`AbstractServerHttpExchange()`

Method Summary

Methods
Modifier and Type	Method and Description
`ServerHttpExchange`	`bodyAction(Action action)` Attaches an action to be called with the whole request body.
`ServerHttpExchange`	`chunkAction(Action action)` Attaches an action to be called with a chunk from the request body.
`ServerHttpExchange`	`closeAction(Action<Void> action)` Attaches an action to be called when both request and response end successfully or the underlying connection is aborted for some reason like an error.
`protected abstract void`	`doEnd()`
`protected abstract void`	`doRead(Action<ByteBuffer> chunkAction)`
`protected abstract void`	`doSetHeader(String name, String value)`
`protected abstract void`	`doSetStatus(HttpStatus status)`
`protected abstract void`	`doWrite(ByteBuffer byteBuffer)`
`ServerHttpExchange`	`end()` Completes the response.
`ServerHttpExchange`	`end(ByteBuffer data)` Writes a binary chunk to the response body and completes the response through `ServerHttpExchange.end()`.
`ServerHttpExchange`	`end(String data)` Writes a text chunk to the response body using the charset from the response header, `content-type` and completes the response through `ServerHttpExchange.end()`.
`ServerHttpExchange`	`end(String data, String charsetName)` Writes a text chunk to the response body using the given charset and completes the response through `ServerHttpExchange.end()`.
`ServerHttpExchange`	`endAction(Action<Void> action)` Attaches an action to be called when the request is fully read.
`ServerHttpExchange`	`errorAction(Action<Throwable> action)` Attaches an action to be called when this exchange gets an error.
`String`	`header(String name)` Returns the first request header associated with the given name.
`ServerHttpExchange`	`read()` Reads the request body.
`ServerHttpExchange`	`readAsBinary()` Reads the request body as binary.
`ServerHttpExchange`	`readAsText()` Reads the request body as text.
`ServerHttpExchange`	`readAsText(String charsetName)` Reads the request body as text using the given charset.
`ServerHttpExchange`	`setHeader(String name, Iterable<String> value)` Sets response headers.
`ServerHttpExchange`	`setHeader(String name, String value)` Sets a response header.
`ServerHttpExchange`	`setStatus(HttpStatus status)` Sets the HTTP status for the response.
`ServerHttpExchange`	`write(ByteBuffer byteBuffer)` Writes a binary chunk to the response body.
`ServerHttpExchange`	`write(String data)` Writes a text chunk to the response body using the charset from the response header, `content-type`.
`ServerHttpExchange`	`write(String data, String charsetName)` Writes a text chunk to the response body using the given charset.

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

Methods inherited from interface org.atmosphere.vibe.platform.http.ServerHttpExchange
headerNames, headers, method, unwrap, uri

- Field Detail
  - endActions
```
protected final Actions<Void> endActions
```
  - errorActions
```
protected final Actions<Throwable> errorActions
```
  - closeActions
```
protected final Actions<Void> closeActions
```
- Constructor Detail
  - AbstractServerHttpExchange
```
public AbstractServerHttpExchange()
```
- Method Detail
  - header
```
public String header(String name)
```
    Description copied from interface: ServerHttpExchange
    
    Returns the first request header associated with the given name.
    
    Specified by:
    
    header in interface ServerHttpExchange
  - read
```
public ServerHttpExchange read()
```
    Description copied from interface: ServerHttpExchange
    
    Reads the request body. If the request header, content-type, starts with text/, the body is read as text, and if not, as binary. In case of text body, the charset is also determined by the same header. If it's not given, ISO-8859-1 is used by default.
    The read data will be passed to event handlers as String if it's text and ByteBuffer if it's binary attached through ServerHttpExchange.chunkAction(Action).
    This method should be called after adding ServerHttpExchange.chunkAction(Action), ServerHttpExchange.bodyAction(Action), and ServerHttpExchange.endAction(Action) and has no side effect if called more than once.
    
    Specified by:
    
    read in interface ServerHttpExchange
  - readAsText
```
public ServerHttpExchange readAsText()
```
    Description copied from interface: ServerHttpExchange
    
    Reads the request body as text. The charset is determined by the request header, content-type. If it's not given, ISO-8859-1 is used by default.
    The read data will be passed to event handlers as String attached through ServerHttpExchange.chunkAction(Action).
    This method should be called after adding ServerHttpExchange.chunkAction(Action), ServerHttpExchange.bodyAction(Action), and ServerHttpExchange.endAction(Action) and has no side effect if called more than once.
    
    Specified by:
    
    readAsText in interface ServerHttpExchange
  - readAsText
```
public ServerHttpExchange readAsText(String charsetName)
```
    Description copied from interface: ServerHttpExchange
    
    Reads the request body as text using the given charset.
    The read data will be passed to event handlers as String attached through ServerHttpExchange.chunkAction(Action).
    This method should be called after adding ServerHttpExchange.chunkAction(Action), ServerHttpExchange.bodyAction(Action), and ServerHttpExchange.endAction(Action) and has no side effect if called more than once.
    
    Specified by:
    
    readAsText in interface ServerHttpExchange
  - readAsBinary
```
public ServerHttpExchange readAsBinary()
```
    Description copied from interface: ServerHttpExchange
    
    Reads the request body as binary.
    The read data will be passed to event handlers as ByteBuffer attached through ServerHttpExchange.chunkAction(Action).
    This method should be called after adding ServerHttpExchange.chunkAction(Action), ServerHttpExchange.bodyAction(Action), and ServerHttpExchange.endAction(Action) and has no side effect if called more than once.
    
    Specified by:
    
    readAsBinary in interface ServerHttpExchange
  - doRead
```
protected abstract void doRead(Action<ByteBuffer> chunkAction)
```
  - chunkAction
```
public ServerHttpExchange chunkAction(Action action)
```
    Description copied from interface: ServerHttpExchange
    
    Attaches an action to be called with a chunk from the request body. The allowed data type is String for text body and ByteBuffer for binary body.
    
    Specified by:
    
    chunkAction in interface ServerHttpExchange
  - endAction
```
public ServerHttpExchange endAction(Action<Void> action)
```
    Description copied from interface: ServerHttpExchange
    
    Attaches an action to be called when the request is fully read. It's the end of the request.
    
    Specified by:
    
    endAction in interface ServerHttpExchange
  - bodyAction
```
public ServerHttpExchange bodyAction(Action action)
```
    Description copied from interface: ServerHttpExchange
    
    Attaches an action to be called with the whole request body. The allowed data type is String for text body and ByteBuffer for binary body. If the body is quite big, it may drain memory quickly.
    
    Specified by:
    
    bodyAction in interface ServerHttpExchange
  - setStatus
```
public ServerHttpExchange setStatus(HttpStatus status)
```
    Description copied from interface: ServerHttpExchange
    
    Sets the HTTP status for the response.
    
    Specified by:
    
    setStatus in interface ServerHttpExchange
  - doSetStatus
```
protected abstract void doSetStatus(HttpStatus status)
```
  - setHeader
```
public final ServerHttpExchange setHeader(String name,
                           Iterable<String> value)
```
    Description copied from interface: ServerHttpExchange
    
    Sets response headers.
    
    Specified by:
    
    setHeader in interface ServerHttpExchange
  - setHeader
```
public ServerHttpExchange setHeader(String name,
                           String value)
```
    Description copied from interface: ServerHttpExchange
    
    Sets a response header.
    
    Specified by:
    
    setHeader in interface ServerHttpExchange
  - doSetHeader
```
protected abstract void doSetHeader(String name,
               String value)
```
  - write
```
public ServerHttpExchange write(String data)
```
    Description copied from interface: ServerHttpExchange
    
    Writes a text chunk to the response body using the charset from the response header, content-type. If it's not given, ISO-8859-1 is used.
    
    Specified by:
    
    write in interface ServerHttpExchange
  - write
```
public ServerHttpExchange write(String data,
                       String charsetName)
```
    Description copied from interface: ServerHttpExchange
    
    Writes a text chunk to the response body using the given charset.
    
    Specified by:
    
    write in interface ServerHttpExchange
  - write
```
public ServerHttpExchange write(ByteBuffer byteBuffer)
```
    Description copied from interface: ServerHttpExchange
    
    Writes a binary chunk to the response body.
    
    Specified by:
    
    write in interface ServerHttpExchange
  - doWrite
```
protected abstract void doWrite(ByteBuffer byteBuffer)
```
  - end
```
public ServerHttpExchange end()
```
    Description copied from interface: ServerHttpExchange
    
    Completes the response. Each exchange's response must be finished with this method when done. It's the end of the response. This method has no side effect if called more than once.
    
    Specified by:
    
    end in interface ServerHttpExchange
  - doEnd
```
protected abstract void doEnd()
```
  - end
```
public ServerHttpExchange end(String data)
```
    Description copied from interface: ServerHttpExchange
    
    Writes a text chunk to the response body using the charset from the response header, content-type and completes the response through ServerHttpExchange.end().
    
    Specified by:
    
    end in interface ServerHttpExchange
  - end
```
public ServerHttpExchange end(String data,
                     String charsetName)
```
    Description copied from interface: ServerHttpExchange
    
    Writes a text chunk to the response body using the given charset and completes the response through ServerHttpExchange.end().
    
    Specified by:
    
    end in interface ServerHttpExchange
  - end
```
public ServerHttpExchange end(ByteBuffer data)
```
    Description copied from interface: ServerHttpExchange
    
    Writes a binary chunk to the response body and completes the response through ServerHttpExchange.end().
    
    Specified by:
    
    end in interface ServerHttpExchange
  - closeAction
```
public ServerHttpExchange closeAction(Action<Void> action)
```
    Description copied from interface: ServerHttpExchange
    
    Attaches an action to be called when both request and response end successfully or the underlying connection is aborted for some reason like an error. After this event, all the other event will be disabled.
    
    Specified by:
    
    closeAction in interface ServerHttpExchange
  - errorAction
```
public ServerHttpExchange errorAction(Action<Throwable> action)
```
    Description copied from interface: ServerHttpExchange
    
    Attaches an action to be called when this exchange gets an error. It may or may not accompany the closure of connection. Its exact behavior is platform-specific and error created by the platform is propagated.
    
    Specified by:
    
    errorAction in interface ServerHttpExchange

Class AbstractServerHttpExchange

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.atmosphere.vibe.platform.http.ServerHttpExchange

Field Detail

endActions

errorActions

closeActions

Constructor Detail

AbstractServerHttpExchange

Method Detail

header

read

readAsText

readAsText

readAsBinary

doRead

chunkAction

endAction

bodyAction

setStatus

doSetStatus

setHeader

setHeader

doSetHeader

write

write

write

doWrite

end

doEnd

end

end

end

closeAction

errorAction