org.atmosphere.vibe.platform.server

Interface ServerHttpExchange

All Superinterfaces:

Wrapper

All Known Implementing Classes:

AbstractServerHttpExchange

public interface ServerHttpExchange
extends Wrapper

Represents a server-side HTTP request-response exchange.

Implementations are not thread-safe and decide whether and which event is fired in asynchronous manner.

Author:

Donghwan Kim

See Also:

RFC2616 - Hypertext Transfer Protocol -- HTTP/1.1

Method Summary

Methods

Modifier and Type	Method and Description
ServerHttpExchange	bodyAction(Action<Data> action) Attaches an action to be called with the whole request body where the request ends.
ServerHttpExchange	close() Closes the response.
ServerHttpExchange	close(ByteBuffer byteBuffer) Writes a byte to the response body and close the response.
ServerHttpExchange	close(String data) Writes a string to the response body and close the response.
ServerHttpExchange	closeAction(Action<Void> action) Attaches an action to be called on response close.
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.
String	method() The name of the request method.
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.
String	uri() The request URI used to connect.
ServerHttpExchange	write(ByteBuffer byteBuffer) Writes a byte body to the response body.
ServerHttpExchange	write(String data) Writes a text to the response body.

Methods inherited from interface org.atmosphere.vibe.platform.Wrapper

unwrap

Method Detail

uri

String uri()

The request URI used to connect.

method

String 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. When iterating the set unlike getting the header value, you should make it lower-case or upper-case and use it.

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.

bodyAction

ServerHttpExchange bodyAction(Action<Data> action)

Attaches an action to be called with the whole request body where the request ends. If the body is quite big, it may drain memory quickly.

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 to the response body.

write

ServerHttpExchange write(ByteBuffer byteBuffer)

Writes a byte body to the response body.

close

ServerHttpExchange close()

Closes the response. Each exchange must be finished with this method when done. This method has no side effect if called more than once.

close

ServerHttpExchange close(String data)

Writes a string to the response body and close the response.

close

ServerHttpExchange close(ByteBuffer byteBuffer)

Writes a byte to the response body and close the response.

setStatus

ServerHttpExchange setStatus(HttpStatus status)

Sets the HTTP status for the response.

closeAction

ServerHttpExchange closeAction(Action<Void> action)

Attaches an action to be called on response close.