io.higgs.http.server

Class HttpResponse

java.lang.Object

io.netty.handler.codec.http.DefaultHttpObject

io.netty.handler.codec.http.DefaultHttpMessage

io.netty.handler.codec.http.DefaultHttpResponse

io.netty.handler.codec.http.DefaultFullHttpResponse

io.higgs.http.server.HttpResponse

All Implemented Interfaces:

io.netty.buffer.ByteBufHolder, 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 HttpResponse
extends io.netty.handler.codec.http.DefaultFullHttpResponse

Author:

Courtney Robinson

Field Summary

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

EMPTY_LAST_CONTENT

Constructor Summary

Constructors

Constructor and Description
HttpResponse() creates a 200 ok response
HttpResponse(io.netty.buffer.ByteBuf buffer)
HttpResponse(HttpRequest message) Initializes a response with 200 status and sets the connection header to whatever the client requested.
HttpResponse(io.netty.handler.codec.http.HttpResponseStatus status)
HttpResponse(HttpStatus status, io.netty.buffer.ByteBuf buffer)
HttpResponse(io.netty.handler.codec.http.HttpVersion version, io.netty.handler.codec.http.HttpResponseStatus status) Creates a new instance.
HttpResponse(io.netty.handler.codec.http.HttpVersion version, io.netty.handler.codec.http.HttpResponseStatus status, io.netty.buffer.ByteBuf content)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearHeaders()
io.netty.buffer.ByteBuf	content()
io.netty.channel.ChannelFuture	doManagedWrite()
void	finalizeCustomHeaders(HttpRequest request) sets any overridden headers
io.netty.handler.codec.DecoderResult	getDecoderResult()
ManagedWriter	getManagedWriter()
io.netty.handler.codec.http.HttpVersion	getProtocolVersion()
io.netty.handler.codec.http.HttpResponseStatus	getStatus()
io.netty.handler.codec.http.HttpHeaders	headers()
boolean	isRedirect()
void	redirect(String to) Send a 303 (See Other) redirect
void	resetContent(io.netty.buffer.ByteBuf buffer)
void	setCookie(HttpCookie cookie)
void	setCookie(String name, String value) Sets a cookie with path as "/"
void	setCookies(Map<String,HttpCookie> cookies)
void	setDecoderResult(io.netty.handler.codec.DecoderResult result)
void	setManagedWriter(ManagedWriter managedWriter)
io.netty.handler.codec.http.FullHttpResponse	setProtocolVersion(io.netty.handler.codec.http.HttpVersion version)
io.netty.handler.codec.http.FullHttpResponse	setStatus(io.netty.handler.codec.http.HttpResponseStatus status)

Methods inherited from class io.netty.handler.codec.http.DefaultFullHttpResponse

copy, duplicate, refCnt, release, release, retain, retain, trailingHeaders

Methods inherited from class io.netty.handler.codec.http.DefaultHttpResponse

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpResponse

public HttpResponse(HttpRequest message)

Initializes a response with 200 status and sets the connection header to whatever the client requested. If no connection header is found in the client request then it is set to CLOSE

Parameters:

message -

HttpResponse

public HttpResponse(io.netty.handler.codec.http.HttpVersion version,
            io.netty.handler.codec.http.HttpResponseStatus status)

Creates a new instance.

Parameters:

version - the HTTP version of this response

status - the status of this response

HttpResponse

public HttpResponse(io.netty.handler.codec.http.HttpVersion version,
            io.netty.handler.codec.http.HttpResponseStatus status,
            io.netty.buffer.ByteBuf content)

HttpResponse

public HttpResponse()

creates a 200 ok response

HttpResponse

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

HttpResponse

public HttpResponse(io.netty.buffer.ByteBuf buffer)

HttpResponse

public HttpResponse(HttpStatus status,
            io.netty.buffer.ByteBuf buffer)

Method Detail

headers

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

Specified by:

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

Overrides:

headers in class io.netty.handler.codec.http.DefaultHttpMessage

getProtocolVersion

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

Specified by:

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

Overrides:

getProtocolVersion in class io.netty.handler.codec.http.DefaultHttpMessage

content

public io.netty.buffer.ByteBuf content()

Specified by:

content in interface io.netty.buffer.ByteBufHolder

Overrides:

content in class io.netty.handler.codec.http.DefaultFullHttpResponse

setProtocolVersion

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

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

Overrides:

setProtocolVersion in class io.netty.handler.codec.http.DefaultFullHttpResponse

setStatus

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

Specified by:

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

Specified by:

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

Overrides:

setStatus in class io.netty.handler.codec.http.DefaultFullHttpResponse

setCookies

public void setCookies(Map<String,HttpCookie> cookies)

setCookie

public void setCookie(String name,
             String value)

Sets a cookie with path as "/"

Parameters:

name -

value -

setCookie

public void setCookie(HttpCookie cookie)

clearHeaders

public void clearHeaders()

finalizeCustomHeaders

public void finalizeCustomHeaders(HttpRequest request)

sets any overridden headers

doManagedWrite

public io.netty.channel.ChannelFuture doManagedWrite()

getManagedWriter

public ManagedWriter getManagedWriter()

setManagedWriter

public void setManagedWriter(ManagedWriter managedWriter)

getStatus

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

Specified by:

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

Overrides:

getStatus in class io.netty.handler.codec.http.DefaultHttpResponse

getDecoderResult

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

Specified by:

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

Overrides:

getDecoderResult in class io.netty.handler.codec.http.DefaultHttpObject

setDecoderResult

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

Specified by:

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

Overrides:

setDecoderResult in class io.netty.handler.codec.http.DefaultHttpObject

redirect

public void redirect(String to)

Send a 303 (See Other) redirect

Parameters:

to - the location to redirect to

isRedirect

public boolean isRedirect()

resetContent

public void resetContent(io.netty.buffer.ByteBuf buffer)