sinetja

Class Response

java.lang.Object

sinetja.Response

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, io.netty.handler.codec.DecoderResultProvider, io.netty.handler.codec.http.FullHttpMessage, io.netty.handler.codec.http.FullHttpResponse, io.netty.handler.codec.http.HttpContent, io.netty.handler.codec.http.HttpMessage, io.netty.handler.codec.http.HttpObject, io.netty.handler.codec.http.HttpResponse, io.netty.handler.codec.http.LastHttpContent, io.netty.util.ReferenceCounted

public class Response
extends java.lang.Object
implements io.netty.handler.codec.http.FullHttpResponse

Field Summary

Fields inherited from interface io.netty.handler.codec.http.LastHttpContent

EMPTY_LAST_CONTENT

Constructor Summary

Constructors

Constructor and Description
Response(Server server, io.netty.channel.Channel channel, Request request, io.netty.handler.codec.http.router.RouteResult routeResult)

Method Summary

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	content()
io.netty.handler.codec.http.FullHttpResponse	copy()
io.netty.handler.codec.DecoderResult	decoderResult()
boolean	doneResponding()
io.netty.handler.codec.http.FullHttpResponse	duplicate()
io.netty.handler.codec.DecoderResult	getDecoderResult()
io.netty.handler.codec.http.HttpVersion	getProtocolVersion()
io.netty.handler.codec.http.HttpResponseStatus	getStatus()
io.netty.handler.codec.http.HttpHeaders	headers()
io.netty.handler.codec.http.HttpVersion	protocolVersion()
int	refCnt()
boolean	release()
boolean	release(int arg0)
java.lang.String	renderEventSource(java.lang.Object data)
java.lang.String	renderEventSource(java.lang.Object data, java.lang.String event)
io.netty.handler.codec.http.FullHttpResponse	replace(io.netty.buffer.ByteBuf content)
io.netty.channel.ChannelFuture	respond()
io.netty.channel.ChannelFuture	respondBinary(byte[] bytes) If Content-Type header is not set, it is set to "application/octet-stream".
io.netty.channel.ChannelFuture	respondBinary(io.netty.buffer.ByteBuf byteBuf) If Content-Type header is not set, it is set to "application/octet-stream".
io.netty.channel.ChannelFuture	respondEventSource(java.lang.Object data) To respond event source, call this method as many time as you want.
io.netty.channel.ChannelFuture	respondEventSource(java.lang.Object data, java.lang.String event) To respond event source, call this method as many time as you want.
io.netty.channel.ChannelFuture	respondFile(java.io.File file)
io.netty.channel.ChannelFuture	respondFile(java.lang.String filePath)
io.netty.channel.ChannelFuture	respondHtml(java.lang.Object any) Content-Type header is set to "text/html".
io.netty.channel.ChannelFuture	respondJs(java.lang.Object any) Content-Type header is set to "application/javascript".
io.netty.channel.ChannelFuture	respondJson(java.lang.Object ref) Converts the given Java object to JSON object using Jackson ObjectMapper, and responds it.
io.netty.channel.ChannelFuture	respondJsonP(java.lang.Object ref, java.lang.String function) Converts the given Java object to JSON object using Jackson ObjectMapper, wraps it with the given JavaScript function name, and responds.
io.netty.channel.ChannelFuture	respondJsonPText(java.lang.Object text, java.lang.String function) Wraps the text with the given JavaScript function name, and responds.
io.netty.channel.ChannelFuture	respondJsonText(java.lang.Object any) Content-Type header is set to "application/json".
io.netty.channel.ChannelFuture	respondText(java.lang.Object text)
io.netty.channel.ChannelFuture	respondText(java.lang.Object text, java.lang.String fallbackContentType)
io.netty.channel.ChannelFuture	respondXml(java.lang.Object any) Content-Type header is set to "application/xml".
io.netty.handler.codec.http.FullHttpResponse	retain()
io.netty.handler.codec.http.FullHttpResponse	retain(int arg0)
io.netty.handler.codec.http.FullHttpResponse	retainedDuplicate()
void	setClientCacheAggressively()
void	setDecoderResult(io.netty.handler.codec.DecoderResult arg0)
void	setNoClientCache()
io.netty.handler.codec.http.FullHttpResponse	setProtocolVersion(io.netty.handler.codec.http.HttpVersion arg0)
io.netty.handler.codec.http.FullHttpResponse	setStatus(io.netty.handler.codec.http.HttpResponseStatus arg0)
io.netty.handler.codec.http.HttpResponseStatus	status()
java.lang.String	toString()
io.netty.handler.codec.http.FullHttpResponse	touch()
io.netty.handler.codec.http.FullHttpResponse	touch(java.lang.Object hint)
io.netty.handler.codec.http.HttpHeaders	trailingHeaders()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Response

public Response(Server server,
                io.netty.channel.Channel channel,
                Request request,
                io.netty.handler.codec.http.router.RouteResult routeResult)

Method Detail

doneResponding

public boolean doneResponding()

setClientCacheAggressively

public void setClientCacheAggressively()

setNoClientCache

public void setNoClientCache()

respond

public io.netty.channel.ChannelFuture respond()
                                       throws java.lang.Exception

Throws:

java.lang.Exception

respondText

public io.netty.channel.ChannelFuture respondText(java.lang.Object text)
                                           throws java.lang.Exception

Throws:

java.lang.Exception

respondText

public io.netty.channel.ChannelFuture respondText(java.lang.Object text,
                                                  java.lang.String fallbackContentType)
                                           throws java.lang.Exception

Parameters:

fallbackContentType - Only used if Content-Type header has not been set. If not given and Content-Type header is not set, it is set to "application/xml" if text param is Node or NodeSeq, otherwise it is set to "text/plain".

Throws:

java.lang.Exception

respondXml

public io.netty.channel.ChannelFuture respondXml(java.lang.Object any)
                                          throws java.lang.Exception

Content-Type header is set to "application/xml".

Throws:

java.lang.Exception

respondHtml

public io.netty.channel.ChannelFuture respondHtml(java.lang.Object any)
                                           throws java.lang.Exception

Content-Type header is set to "text/html".

Throws:

java.lang.Exception

respondJs

public io.netty.channel.ChannelFuture respondJs(java.lang.Object any)
                                         throws java.lang.Exception

Content-Type header is set to "application/javascript".

Throws:

java.lang.Exception

respondJsonText

public io.netty.channel.ChannelFuture respondJsonText(java.lang.Object any)
                                               throws java.lang.Exception

Content-Type header is set to "application/json".

Throws:

java.lang.Exception

respondJson

public io.netty.channel.ChannelFuture respondJson(java.lang.Object ref)
                                           throws java.lang.Exception

Converts the given Java object to JSON object using Jackson ObjectMapper, and responds it. If you just want to respond a text with "application/json" as content type, use respondJsonText(text).

Content-Type header is set to "application/json". "text/json" would make the browser download instead of displaying the content. It makes debugging a pain.

Throws:

java.lang.Exception

respondJsonPText

public io.netty.channel.ChannelFuture respondJsonPText(java.lang.Object text,
                                                       java.lang.String function)
                                                throws java.lang.Exception

Wraps the text with the given JavaScript function name, and responds.

Content-Type header is set to "application/javascript".

Throws:

java.lang.Exception

respondJsonP

public io.netty.channel.ChannelFuture respondJsonP(java.lang.Object ref,
                                                   java.lang.String function)
                                            throws java.lang.Exception

Converts the given Java object to JSON object using Jackson ObjectMapper, wraps it with the given JavaScript function name, and responds. If you already have a JSON text, thus no conversion is needed, use respondJsonPText.

Content-Type header is set to "application/javascript".

Throws:

java.lang.Exception

respondBinary

public io.netty.channel.ChannelFuture respondBinary(byte[] bytes)
                                             throws java.lang.Exception

If Content-Type header is not set, it is set to "application/octet-stream".

Throws:

java.lang.Exception

respondBinary

public io.netty.channel.ChannelFuture respondBinary(io.netty.buffer.ByteBuf byteBuf)
                                             throws java.lang.Exception

If Content-Type header is not set, it is set to "application/octet-stream".

Parameters:

byteBuf - Will be released

Throws:

java.lang.Exception

respondFile

public io.netty.channel.ChannelFuture respondFile(java.lang.String filePath)

respondFile

public io.netty.channel.ChannelFuture respondFile(java.io.File file)

renderEventSource

public java.lang.String renderEventSource(java.lang.Object data)

renderEventSource

public java.lang.String renderEventSource(java.lang.Object data,
                                          java.lang.String event)

respondEventSource

public io.netty.channel.ChannelFuture respondEventSource(java.lang.Object data)
                                                  throws java.lang.Exception

To respond event source, call this method as many time as you want.

Event Source response is a special kind of chunked response, data must be UTF-8. See: - http://sockjs.github.com/sockjs-protocol/sockjs-protocol-0.3.3.html#section-94 - http://dev.w3.org/html5/eventsource/

No need to call setChunked() before calling this method.

Throws:

java.lang.Exception

respondEventSource

public io.netty.channel.ChannelFuture respondEventSource(java.lang.Object data,
                                                         java.lang.String event)
                                                  throws java.lang.Exception

To respond event source, call this method as many time as you want.

Event Source response is a special kind of chunked response, data must be UTF-8. See: - http://sockjs.github.com/sockjs-protocol/sockjs-protocol-0.3.3.html#section-94 - http://dev.w3.org/html5/eventsource/

No need to call setChunked() before calling this method.

Throws:

java.lang.Exception

getStatus

public io.netty.handler.codec.http.HttpResponseStatus getStatus()

Specified by:

getStatus in interface io.netty.handler.codec.http.HttpResponse

status

public io.netty.handler.codec.http.HttpResponseStatus status()

Specified by:

status in interface io.netty.handler.codec.http.HttpResponse

getProtocolVersion

public io.netty.handler.codec.http.HttpVersion getProtocolVersion()

Specified by:

getProtocolVersion in interface io.netty.handler.codec.http.HttpMessage

protocolVersion

public io.netty.handler.codec.http.HttpVersion protocolVersion()

Specified by:

protocolVersion in interface io.netty.handler.codec.http.HttpMessage

headers

public io.netty.handler.codec.http.HttpHeaders headers()

Specified by:

headers in interface io.netty.handler.codec.http.HttpMessage

getDecoderResult

public io.netty.handler.codec.DecoderResult getDecoderResult()

Specified by:

getDecoderResult in interface io.netty.handler.codec.http.HttpObject

decoderResult

public io.netty.handler.codec.DecoderResult decoderResult()

Specified by:

decoderResult in interface io.netty.handler.codec.DecoderResultProvider

setDecoderResult

public void setDecoderResult(io.netty.handler.codec.DecoderResult arg0)

Specified by:

setDecoderResult in interface io.netty.handler.codec.DecoderResultProvider

trailingHeaders

public io.netty.handler.codec.http.HttpHeaders trailingHeaders()

Specified by:

trailingHeaders in interface io.netty.handler.codec.http.LastHttpContent

retainedDuplicate

public io.netty.handler.codec.http.FullHttpResponse retainedDuplicate()

Specified by:

retainedDuplicate in interface io.netty.buffer.ByteBufHolder

Specified by:

retainedDuplicate in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

retainedDuplicate in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

retainedDuplicate in interface io.netty.handler.codec.http.HttpContent

Specified by:

retainedDuplicate in interface io.netty.handler.codec.http.LastHttpContent

replace

public io.netty.handler.codec.http.FullHttpResponse replace(io.netty.buffer.ByteBuf content)

Specified by:

replace in interface io.netty.buffer.ByteBufHolder

Specified by:

replace in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

replace in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

replace in interface io.netty.handler.codec.http.HttpContent

Specified by:

replace in interface io.netty.handler.codec.http.LastHttpContent

content

public io.netty.buffer.ByteBuf content()

Specified by:

content in interface io.netty.buffer.ByteBufHolder

refCnt

public int refCnt()

Specified by:

refCnt in interface io.netty.util.ReferenceCounted

release

public boolean release()

Specified by:

release in interface io.netty.util.ReferenceCounted

release

public boolean release(int arg0)

Specified by:

release in interface io.netty.util.ReferenceCounted

copy

public io.netty.handler.codec.http.FullHttpResponse copy()

Specified by:

copy in interface io.netty.buffer.ByteBufHolder

Specified by:

copy in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

copy in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

copy in interface io.netty.handler.codec.http.HttpContent

Specified by:

copy in interface io.netty.handler.codec.http.LastHttpContent

duplicate

public io.netty.handler.codec.http.FullHttpResponse duplicate()

Specified by:

duplicate in interface io.netty.buffer.ByteBufHolder

Specified by:

duplicate in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

duplicate in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

duplicate in interface io.netty.handler.codec.http.HttpContent

Specified by:

duplicate in interface io.netty.handler.codec.http.LastHttpContent

retain

public io.netty.handler.codec.http.FullHttpResponse retain()

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

retain in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

retain in interface io.netty.handler.codec.http.HttpContent

Specified by:

retain in interface io.netty.handler.codec.http.LastHttpContent

Specified by:

retain in interface io.netty.util.ReferenceCounted

touch

public io.netty.handler.codec.http.FullHttpResponse touch()

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

touch in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

touch in interface io.netty.handler.codec.http.HttpContent

Specified by:

touch in interface io.netty.handler.codec.http.LastHttpContent

Specified by:

touch in interface io.netty.util.ReferenceCounted

touch

public io.netty.handler.codec.http.FullHttpResponse touch(java.lang.Object hint)

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

touch in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

touch in interface io.netty.handler.codec.http.HttpContent

Specified by:

touch in interface io.netty.handler.codec.http.LastHttpContent

Specified by:

touch in interface io.netty.util.ReferenceCounted

retain

public io.netty.handler.codec.http.FullHttpResponse retain(int arg0)

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.handler.codec.http.FullHttpMessage

Specified by:

retain in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

retain in interface io.netty.handler.codec.http.HttpContent

Specified by:

retain in interface io.netty.handler.codec.http.LastHttpContent

Specified by:

retain in interface io.netty.util.ReferenceCounted

setProtocolVersion

public io.netty.handler.codec.http.FullHttpResponse setProtocolVersion(io.netty.handler.codec.http.HttpVersion arg0)

Specified by:

setProtocolVersion in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

setProtocolVersion in interface io.netty.handler.codec.http.HttpMessage

Specified by:

setProtocolVersion in interface io.netty.handler.codec.http.HttpResponse

setStatus

public io.netty.handler.codec.http.FullHttpResponse setStatus(io.netty.handler.codec.http.HttpResponseStatus arg0)

Specified by:

setStatus in interface io.netty.handler.codec.http.FullHttpResponse

Specified by:

setStatus in interface io.netty.handler.codec.http.HttpResponse

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object