io.higgs.http.server

Class HttpRequest

java.lang.Object

io.netty.handler.codec.http.DefaultHttpObject

io.netty.handler.codec.http.DefaultHttpMessage

io.netty.handler.codec.http.DefaultHttpRequest

io.higgs.http.server.HttpRequest

All Implemented Interfaces:

io.netty.handler.codec.http.HttpMessage, io.netty.handler.codec.http.HttpObject, io.netty.handler.codec.http.HttpRequest

public class HttpRequest
extends io.netty.handler.codec.http.DefaultHttpRequest

Author:

Courtney Robinson

Field Summary

Fields

Modifier and Type	Field and Description
protected List<MediaType>	acceptedMediaTypes
protected boolean	chunked
protected HttpProtocolConfiguration	config
protected io.netty.buffer.ByteBuf	content
protected List<MediaType>	contentType
protected HttpCookies	cookies
protected org.joda.time.DateTime	createdAt
protected FormFiles	files
protected FormParams	form
protected org.slf4j.Logger	log
protected MediaType	matchedMediaType
protected boolean	multipart
protected boolean	newSession
protected ResourcePath	path
protected QueryParams	queryParams
protected org.apache.shiro.session.Session	session
protected static io.netty.util.AttributeKey<String>	sessionAttr
protected HttpCookie	sessionCookie
protected String	sessionId
static String	SID
protected org.apache.shiro.subject.Subject	subject

Constructor Summary

Constructors

Constructor and Description
HttpRequest(io.netty.handler.codec.http.FullHttpRequest msg)
HttpRequest(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpMethod method, String uri) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFormField(String name, Object value)
void	addFormFile(HttpFile file)
io.netty.buffer.ByteBuf	content()
List<MediaType>	getAcceptedMediaTypes()
HttpProtocolConfiguration	getConfig()
List<MediaType>	getContentType()
HttpCookie	getCookie(String name)
HttpCookies	getCookies()
org.joda.time.DateTime	getCreatedAt()
FormFiles	getFormFiles() Get all files uploaded with this request
FormParams	getFormParam() Get all form fields send with this request
MediaType	getMatchedMediaType()
ResourcePath	getPath()
QueryParams	getQueryParams() Get the query string parameters associated with this request
HttpCookie	getSessionCookie()
String	getSessionId()
org.apache.shiro.subject.Subject	getSubject()
void	init(io.netty.channel.ChannelHandlerContext ctx) Because some custom fields depend on headers not set on construction this method must be invoked after Netty populates the headers.
void	initSession(io.netty.channel.ChannelHandlerContext ctx)
boolean	isChunked()
boolean	isDelete()
boolean	isGet()
boolean	isHead()
boolean	isMultipart()
boolean	isNewSession()
boolean	isOptions()
boolean	isPost()
boolean	isPut()
void	setChunked(boolean chunked)
void	setConfig(HttpProtocolConfiguration config)
void	setCookie(HttpCookie cookie)
void	setCookie(String name, String value) Sets a cookie with path as "/"
void	setMatchedMediaType(MediaType matchedMediaType)
void	setMultipart(boolean multipart)
void	setPath(ResourcePath path)
String	toString()

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

getMethod, getUri, setMethod, setProtocolVersion, setUri

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

getProtocolVersion, headers

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

getDecoderResult, setDecoderResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.handler.codec.http.HttpMessage

getProtocolVersion, headers

Methods inherited from interface io.netty.handler.codec.http.HttpObject

getDecoderResult, setDecoderResult

Field Detail

SID

public static final String SID

See Also:

Constant Field Values

sessionAttr

protected static final io.netty.util.AttributeKey<String> sessionAttr

queryParams

protected final QueryParams queryParams

files

protected final FormFiles files

form

protected final FormParams form

cookies

protected final HttpCookies cookies

createdAt

protected final org.joda.time.DateTime createdAt

log

protected org.slf4j.Logger log

path

protected ResourcePath path

acceptedMediaTypes

protected List<MediaType> acceptedMediaTypes

newSession

protected boolean newSession

sessionId

protected String sessionId

matchedMediaType

protected MediaType matchedMediaType

config

protected HttpProtocolConfiguration config

multipart

protected boolean multipart

chunked

protected boolean chunked

content

protected io.netty.buffer.ByteBuf content

sessionCookie

protected HttpCookie sessionCookie

contentType

protected List<MediaType> contentType

session

protected org.apache.shiro.session.Session session

subject

protected org.apache.shiro.subject.Subject subject

Constructor Detail

HttpRequest

public HttpRequest(io.netty.handler.codec.http.FullHttpRequest msg)

HttpRequest

public HttpRequest(io.netty.handler.codec.http.HttpVersion httpVersion,
           io.netty.handler.codec.http.HttpMethod method,
           String uri)

Creates a new instance.

Parameters:

httpVersion - the HTTP version of the request

method - the HTTP method of the request

uri - the URI or path of the request

Method Detail

init

public void init(io.netty.channel.ChannelHandlerContext ctx)

Because some custom fields depend on headers not set on construction this method must be invoked after Netty populates the headers.

Parameters:

ctx -

initSession

public void initSession(io.netty.channel.ChannelHandlerContext ctx)

getCookie

public HttpCookie getCookie(String name)

getContentType

public List<MediaType> getContentType()

getAcceptedMediaTypes

public List<MediaType> getAcceptedMediaTypes()

isGet

public boolean isGet()

isPost

public boolean isPost()

isPut

public boolean isPut()

isDelete

public boolean isDelete()

isHead

public boolean isHead()

isOptions

public boolean isOptions()

getPath

public ResourcePath getPath()

setPath

public void setPath(ResourcePath path)

getCookies

public HttpCookies getCookies()

setCookie

public void setCookie(String name,
             String value)

Sets a cookie with path as "/"

Parameters:

name -

value -

setCookie

public void setCookie(HttpCookie cookie)

isNewSession

public boolean isNewSession()

getSessionId

public String getSessionId()

getSessionCookie

public HttpCookie getSessionCookie()

getSubject

public org.apache.shiro.subject.Subject getSubject()

addFormField

public void addFormField(String name,
                Object value)

addFormFile

public void addFormFile(HttpFile file)

getQueryParams

public QueryParams getQueryParams()

Get the query string parameters associated with this request

Returns:

getFormFiles

public FormFiles getFormFiles()

Get all files uploaded with this request

Returns:

getFormParam

public FormParams getFormParam()

Get all form fields send with this request

Returns:

toString

public String toString()

Overrides:

toString in class io.netty.handler.codec.http.DefaultHttpRequest

getCreatedAt

public org.joda.time.DateTime getCreatedAt()

getMatchedMediaType

public MediaType getMatchedMediaType()

Returns:

The media type which matched on this request or MediaType.WILDCARD by default

setMatchedMediaType

public void setMatchedMediaType(MediaType matchedMediaType)

getConfig

public HttpProtocolConfiguration getConfig()

setConfig

public void setConfig(HttpProtocolConfiguration config)

isMultipart

public boolean isMultipart()

setMultipart

public void setMultipart(boolean multipart)

isChunked

public boolean isChunked()

setChunked

public void setChunked(boolean chunked)

content

public io.netty.buffer.ByteBuf content()