ServerHttpExchange (Asity/HTTP 2.0.0 API)

All Known Implementing Classes:

AbstractServerHttpExchange
```
public interface ServerHttpExchange
```
Represents a server-side HTTP request-response exchange.
Implementations are not thread-safe.

Author:

Donghwan Kim

See Also:

RFC2616 - Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ServerHttpExchange`	`end()` Completes the response.
`ServerHttpExchange`	`end(ByteBuffer byteBuffer)` Writes a binary chunk to the response body and completes the response through `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 `end()`.
`ServerHttpExchange`	`end(String data, String charsetName)` Writes a text chunk to the response body using the given charset and completes the response through `end()`.
`String`	`header(String name)` Returns the first request header associated with the given name.
`Set<String>`	`headerNames()` The names of the request headers.
`List<String>`	`headers(String name)` Returns the request headers associated with the given name or empty list if no header is found.
`HttpMethod`	`method()` The name of the request method.
`ServerHttpExchange`	`onbody(Action<?> action)` Attaches an action to be called with the whole request body.
`ServerHttpExchange`	`onchunk(Action<?> action)` Attaches an action to be called with a chunk from the request body.
`ServerHttpExchange`	`onclose(Action<Void> action)` Attaches an action when the underlying connection is aborted for some reason like an error.
`ServerHttpExchange`	`onend(Action<Void> action)` Attaches an action to be called when the request is fully read.
`ServerHttpExchange`	`onerror(Action<Throwable> action)` Attaches an action to be called when this exchange gets an error.
`ServerHttpExchange`	`onfinish(Action<Void> action)` Attaches an action to be called when the response is fully written.
`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.
`<T> T`	`unwrap(Class<T> clazz)` Returns the provider-specific component.
`String`	`uri()` The request URI.
`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.

- Method Detail
  - uri
```
String uri()
```
    The request URI.
  - method
```
HttpMethod method()
```
    The name of the request method.
  - headerNames
```
Set<String> headerNames()
```
    The names of the request headers. HTTP header is not case-sensitive but Set is case-sensitive.
  - header
```
String header(String name)
```
    Returns the first request header associated with the given name.
  - headers
```
List<String> headers(String name)
```
    Returns the request headers associated with the given name or empty list if no header is found.
  - read
```
ServerHttpExchange read()
```
    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 onchunk(Action).
    This method should be called after adding onchunk(Action), onbody(Action), and onend(Action) and has no side effect if called more than once.
  - readAsText
```
ServerHttpExchange readAsText()
```
    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 onchunk(Action).
    This method should be called after adding onchunk(Action), onbody(Action), and onend(Action) and has no side effect if called more than once.
  - readAsText
```
ServerHttpExchange readAsText(String charsetName)
```
    Reads the request body as text using the given charset.
    The read data will be passed to event handlers as String attached through onchunk(Action).
    This method should be called after adding onchunk(Action), onbody(Action), and onend(Action) and has no side effect if called more than once.
  - readAsBinary
```
ServerHttpExchange readAsBinary()
```
    Reads the request body as binary.
    The read data will be passed to event handlers as ByteBuffer attached through onchunk(Action).
    This method should be called after adding onchunk(Action), onbody(Action), and onend(Action) and has no side effect if called more than once.
  - onchunk
```
ServerHttpExchange onchunk(Action<?> action)
```
    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.
  - onend
```
ServerHttpExchange onend(Action<Void> action)
```
    Attaches an action to be called when the request is fully read. It's the end of the request.
  - onbody
```
ServerHttpExchange onbody(Action<?> action)
```
    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. If that's the case, use onchunk(Action) and onend(Action).
  - setStatus
```
ServerHttpExchange setStatus(HttpStatus status)
```
    Sets the HTTP status for the response.
  - setHeader
```
ServerHttpExchange setHeader(String name,
                             String value)
```
    Sets a response header.
  - setHeader
```
ServerHttpExchange setHeader(String name,
                             Iterable<String> value)
```
    Sets response headers.
  - write
```
ServerHttpExchange write(String data)
```
    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.
  - write
```
ServerHttpExchange write(String data,
                         String charsetName)
```
    Writes a text chunk to the response body using the given charset.
  - write
```
ServerHttpExchange write(ByteBuffer byteBuffer)
```
    Writes a binary chunk to the response body.
  - end
```
ServerHttpExchange end()
```
    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.
  - 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 end().
  - end
```
ServerHttpExchange end(String data,
                       String charsetName)
```
    Writes a text chunk to the response body using the given charset and completes the response through end().
  - end
```
ServerHttpExchange end(ByteBuffer byteBuffer)
```
    Writes a binary chunk to the response body and completes the response through end().
  - onfinish
```
ServerHttpExchange onfinish(Action<Void> action)
```
    Attaches an action to be called when the response is fully written. It's the end of the response.
  - onerror
```
ServerHttpExchange onerror(Action<Throwable> action)
```
    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.
  - onclose
```
ServerHttpExchange onclose(Action<Void> action)
```
    Attaches an action when the underlying connection is aborted for some reason like an error. After this event, all the other event will be disabled.
  - unwrap
```
<T> T unwrap(Class<T> clazz)
```
    Returns the provider-specific component.

Interface ServerHttpExchange

Method Summary

Method Detail

uri

method

headerNames

header

headers

read

readAsText

readAsText

readAsBinary

onchunk

onend

onbody

setStatus

setHeader

setHeader

write

write

write

end

end

end

end

onfinish

onerror

onclose

unwrap