org.atmosphere.vibe.platform.server

Class AbstractServerHttpExchange

java.lang.Object

org.atmosphere.vibe.platform.server.AbstractServerHttpExchange

All Implemented Interfaces:

ServerHttpExchange, Wrapper

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<Data>	bodyActions
protected Actions<Void>	closeActions

Constructor Summary

Constructors

Constructor and Description
AbstractServerHttpExchange()

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 data) 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.
protected abstract void	doClose()
protected abstract void	doSetHeader(String name, String value)
protected abstract void	doSetStatus(HttpStatus status)
protected abstract void	doWrite(ByteBuffer byteBuffer)
protected abstract void	doWrite(String data)
String	header(String name) Returns the first request header associated with the given name.
protected abstract void	readBody()
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 byte body to the response body.
ServerHttpExchange	write(String data) Writes a text to the response body.

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.server.ServerHttpExchange

headerNames, headers, method, uri

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

unwrap

Field Detail

bodyActions

protected final Actions<Data> bodyActions

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

bodyAction

public ServerHttpExchange bodyAction(Action<Data> action)

Description copied from interface: ServerHttpExchange

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.

Specified by:

bodyAction in interface ServerHttpExchange

readBody

protected abstract void readBody()

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

Specified by:

write in interface ServerHttpExchange

write

public ServerHttpExchange write(ByteBuffer byteBuffer)

Description copied from interface: ServerHttpExchange

Writes a byte body to the response body.

Specified by:

write in interface ServerHttpExchange

doWrite

protected abstract void doWrite(ByteBuffer byteBuffer)

doWrite

protected abstract void doWrite(String data)

close

public ServerHttpExchange close()

Description copied from interface: ServerHttpExchange

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

Specified by:

close in interface ServerHttpExchange

doClose

protected abstract void doClose()

close

public ServerHttpExchange close(String data)

Description copied from interface: ServerHttpExchange

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

Specified by:

close in interface ServerHttpExchange

close

public ServerHttpExchange close(ByteBuffer data)

Description copied from interface: ServerHttpExchange

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

Specified by:

close 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)

closeAction

public ServerHttpExchange closeAction(Action<Void> action)

Description copied from interface: ServerHttpExchange

Attaches an action to be called on response close.

Specified by:

closeAction in interface ServerHttpExchange