io.aalam.common

Class HttpRequest

java.lang.Object

io.netty.handler.codec.http.DefaultHttpObject

io.netty.handler.codec.http.DefaultHttpMessage

io.netty.handler.codec.http.DefaultHttpRequest

io.netty.handler.codec.http.DefaultFullHttpRequest

io.aalam.common.HttpRequest

All Implemented Interfaces:

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

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

Class to access the request details. This class inherits from netty's DefaultFullHttpRequest

See Also:

DefaultFullHttpRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	HttpRequest.Auth The authentication parameters for a request.

Field Summary

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

EMPTY_LAST_CONTENT

Constructor Summary

Constructors

Constructor and Description
HttpRequest(io.netty.handler.codec.http.FullHttpRequest req)
HttpRequest(io.netty.handler.codec.http.HttpVersion httpVersion, io.netty.handler.codec.http.HttpMethod method, String uri, io.netty.buffer.ByteBuf content) Application code will not have any use with the constructors as the application code will always process on an initialized request object.

Method Summary

Modifier and Type	Method and Description
HttpRequest.Auth	auth() Returns the auth object of this request.
String	getStaticFile() Get the static file set in this request
String	getStaticUrlResource() Get the static resource set in this request
String	methodName() Get the HTTP method
Map<String,List<String>>	params() Returns the URL parameters.
String	path() Returns the URL path, example, for url GET /aalam/base/users?param1=value&param2=value, the path will be /aalam/base/users
RouteMatch	routeMatch() Application will have no use with this method.
void	setAnonymousAuth() This method will be used by the framework internally.
void	setCookieAuth(String email) This method will be used by the framework internally.
void	setCookieAuth(String email, Integer userId) This method will be used by the framework internally.
void	setExternalAuth(String from) This method will be used by the framework internally.
void	setExternalAuth(String from, String userEmail, Integer id) This method will be used by the framework internally.
void	setInternalAuth(String from, String userEmail) This method will be used by the framework internally.
void	setRouteMatch(RouteMatch obj) Application will have no use with this method.
void	setStaticInfo(String resource, String file) Though applications can pre-inform the static URL and the way to access the static data through build plugin, there might be some situation which would want to send a static file on a non-static URL.
void	setTokenAuth(String appId) This method will be used by the framework internally.
void	setUserPermissions(HashSet<Integer> permissions) Application will have no use with this method.
HashSet<Integer>	userPermissions() Get the permissions of the user initiating this request

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

content, copy, copy, duplicate, equals, hashCode, refCnt, release, release, retain, retain, setMethod, setProtocolVersion, setUri, toString, touch, touch, trailingHeaders

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

getMethod, getUri, method, uri

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

getProtocolVersion, headers, protocolVersion

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

decoderResult, getDecoderResult, setDecoderResult

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getMethod, getUri, method, uri

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

getProtocolVersion, headers, protocolVersion

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

getDecoderResult

Methods inherited from interface io.netty.handler.codec.DecoderResultProvider

decoderResult, setDecoderResult

Constructor Detail

HttpRequest

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

Application code will not have any use with the constructors as the application code will always process on an initialized request object.

HttpRequest

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

Method Detail

path

public String path()

Returns the URL path, example, for url GET /aalam/base/users?param1=value&param2=value, the path will be /aalam/base/users

Returns:

String value of the path

params

public Map<String,List<String>> params()

Returns the URL parameters.

Returns:

Map of string to list of strings - with the key being the parameter name and value being the parameter value.

setRouteMatch

public void setRouteMatch(RouteMatch obj)

Application will have no use with this method. this method will be used by the framework internally.

routeMatch

public RouteMatch routeMatch()

Application will have no use with this method. this method will be used by the framework internally.

methodName

public String methodName()

Get the HTTP method

Returns:

String name of the method

setUserPermissions

public void setUserPermissions(HashSet<Integer> permissions)

Application will have no use with this method. this method will be used by the framework internally.

userPermissions

public HashSet<Integer> userPermissions()

Get the permissions of the user initiating this request

Returns:

Set of permission ids.

setStaticInfo

public void setStaticInfo(String resource,
                          String file)

Though applications can pre-inform the static URL and the way to access the static data through build plugin, there might be some situation which would want to send a static file on a non-static URL. For example, if an application has a static-url prefix as `/aalam/base/s/`. Suppose the application wants to serve a static file in a URL that does not have a prefix `/aalam/base/s/`, or if the file is not on the usual place that the framework can find, it can inform the framework about this static resource through this method This method needs to be called in the action handler. By doing so, the framework will take care of sending the response.

Parameters:

resource - A unique name of this resource. This name should not clash with any of the other static resources.

file - The path to the resource

getStaticUrlResource

public String getStaticUrlResource()

Get the static resource set in this request

Returns:

The resource name

getStaticFile

public String getStaticFile()

Get the static file set in this request

Returns:

The resource's absolute file path

auth

public HttpRequest.Auth auth()

Returns the auth object of this request.

setCookieAuth

public void setCookieAuth(String email,
                          Integer userId)

This method will be used by the framework internally.

setCookieAuth

public void setCookieAuth(String email)

This method will be used by the framework internally.

setTokenAuth

public void setTokenAuth(String appId)

This method will be used by the framework internally.

setInternalAuth

public void setInternalAuth(String from,
                            String userEmail)

This method will be used by the framework internally.

setExternalAuth

public void setExternalAuth(String from)

This method will be used by the framework internally.

setExternalAuth

public void setExternalAuth(String from,
                            String userEmail,
                            Integer id)

This method will be used by the framework internally.

setAnonymousAuth

public void setAnonymousAuth()

This method will be used by the framework internally.