Skip navigation links
A B C D E F G H I J L M N P R S T U V W _ 

A

addHooks(HttpRequest) - Method in class io.aalam.common.HooksHandler
 
adminUser - Static variable in class io.aalam.common.Config
Email id of the owner of this portal.
all(String...) - Static method in class io.aalam.common.Permissions
Initialize a new permissions object with a condition 'all'.
any(String...) - Static method in class io.aalam.common.Permissions
Initialize a new permissions object with a condition 'all'.
appCode - Static variable in class io.aalam.common.Config
The app code of this application.
AppHandler - Class in io.aalam.common
 
AppHandler() - Constructor for class io.aalam.common.AppHandler
 
appProviderCode - Static variable in class io.aalam.common.Config
The provider code of this application.
appsServerPubKey - Static variable in class io.aalam.common.Config
Apps server's public key, used to verify the signature of the requests from aalam apps server
auth() - Method in class io.aalam.common.HttpRequest
Returns the auth object of this request.
Auth(String) - Constructor for class io.aalam.common.HttpRequest.Auth
Authenication parameters will be initialized by the framework.
AuthHandler - Class in io.aalam.common
 
AuthHandler() - Constructor for class io.aalam.common.AuthHandler
 
AuthorizationHandler - Class in io.aalam.common
 
AuthorizationHandler() - Constructor for class io.aalam.common.AuthorizationHandler
 

B

baseappRedisifyName(String) - Static method in class io.aalam.common.Redis
This method is used internal by the framework.
bizCode - Static variable in class io.aalam.common.Config
The code of this portal.
breakPermission(String) - Static method in class io.aalam.common.Permissions
Breaks the fully qualified permission name.

C

Callbacks - Interface in io.aalam.common
Every application using this library will have to implement this class and return an object of that class from it's entry point.
callbacks() - Static method in class io.aalam.common.Launcher
 
centralPubKey - Static variable in class io.aalam.common.Config
The central server's public key, used to verify the signature of the request from aalam central server.
channelRead0(ChannelHandlerContext, Object) - Method in class io.aalam.common.EntryHandler
 
channelRead0(ChannelHandlerContext, Object) - Method in class io.aalam.common.ExitHandler
 
channelRead0(ChannelHandlerContext, HttpResponse) - Method in class io.aalam.common.HttpPostProcessor
 
channelRead0(ChannelHandlerContext, Object) - Method in class io.aalam.common.HttpPrePostProcessor
 
channelRead0(ChannelHandlerContext, HttpRequest) - Method in class io.aalam.common.HttpPreProcessor
 
channelReadComplete(ChannelHandlerContext) - Method in class io.aalam.common.EntryHandler
 
channelReadComplete(ChannelHandlerContext) - Method in class io.aalam.common.ExitHandler
 
channelReadComplete(ChannelHandlerContext) - Method in class io.aalam.common.HttpPostProcessor
 
channelReadComplete(ChannelHandlerContext) - Method in class io.aalam.common.HttpPrePostProcessor
 
channelReadComplete(ChannelHandlerContext) - Method in class io.aalam.common.HttpPreProcessor
 
check(HttpRequest) - Method in class io.aalam.common.Permissions
This method is used internall in the framework and the application has no use for this method.
cleanup() - Method in interface io.aalam.common.Callbacks
This callback will invoked when the application is asked to quit.
cleanup() - Static method in class io.aalam.common.Launcher
 
Client() - Static method in class io.aalam.common.Redis
Return the connection object over which one can issue the redis commands
closeChannel() - Static method in class io.aalam.common.HttpServer
 
Config - Class in io.aalam.common
 
Config() - Constructor for class io.aalam.common.Config
 
conflict(String) - Static method in exception io.aalam.common.HttpException
Returns an Exception object that returns response with status "409 Conflict" and a custom message
connect(String, String[], Object, String) - Method in class io.aalam.common.router.Mapper
Connect a URL to the framework's url router.
connect(String, String[], Object, String, Permissions) - Method in class io.aalam.common.router.Mapper
Connect a URL to the framework's url router.
connect(String, String[], String, Permissions) - Method in class io.aalam.common.router.Mapper.SubMapper
Connect a URL to the framework's url router, using handler that this submapper is initialized with.
connect(String, String[], String) - Method in class io.aalam.common.router.Mapper.SubMapper
Connect a URL to the framework's url router, using handler that this submapper is initialized with.

D

dataDir - Static variable in class io.aalam.common.Config
The absolute path of the directory where this application can use to write data that it wants to persist across reboots.
deleteHooks(HttpRequest) - Method in class io.aalam.common.HooksHandler
 
deny_anon() - Method in class io.aalam.common.Permissions
Deny anonymous requests on a URL
deny_exc(String...) - Method in class io.aalam.common.Permissions
Deny request from any source except the apps mentioned in the args

E

email() - Method in class io.aalam.common.HttpRequest.Auth
Email of the user requesting
EntryHandler - Class in io.aalam.common
 
EntryHandler() - Constructor for class io.aalam.common.EntryHandler
 
entryPoint - Static variable in class io.aalam.common.Config
Entry point defined by this application in its pom.xml
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.aalam.common.AppHandler
 
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.aalam.common.EntryHandler
 
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.aalam.common.ExitHandler
 
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.aalam.common.HttpPostProcessor
 
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.aalam.common.HttpPrePostProcessor
 
exceptionCaught(ChannelHandlerContext, Throwable) - Method in class io.aalam.common.HttpPreProcessor
 
ExitHandler - Class in io.aalam.common
 
ExitHandler() - Constructor for class io.aalam.common.ExitHandler
 

F

forbidden(String) - Static method in exception io.aalam.common.HttpException
Returns an Exception object that returns response with status "403 Forbidden" and a custom message
forbidden() - Static method in class io.aalam.common.HttpResponse
Returns a pre initialized response object with status code "403"
framePermission(String, String, String, String) - Static method in class io.aalam.common.Permissions
Returns the fully qualified permission name.
from() - Method in class io.aalam.common.HttpRequest.Auth
If the URL is requested from other apps or an external source, this method will identify the remote source.

G

get(String) - Static method in class io.aalam.common.RoleCache
Get the permission identifier with it's name
getAppEmail(String, String) - Static method in class io.aalam.common.AuthHandler
 
getArg(String, String, String) - Static method in class io.aalam.common.Config
Application will have no use with this method.
getHttpRequest() - Method in class io.aalam.common.HttpResponse
Get the request object for this response object.
getStaticFile() - Method in class io.aalam.common.HttpRequest
Get the static file set in this request
getStaticUrlResource() - Method in class io.aalam.common.HttpRequest
Get the static resource set in this request

H

hookCallback(HttpRequest) - Method in class io.aalam.common.HooksHandler
 
HooksHandler - Class in io.aalam.common
 
HooksHandler() - Constructor for class io.aalam.common.HooksHandler
 
hooksMap - Static variable in class io.aalam.common.Config
Path to the hooks map containing the application's hook points, defined in it's pom.xml
hostName - Static variable in class io.aalam.common.Config
The hostname in which this application is running.
HtmlSerializer - Class in io.aalam.common.serializers
An abstract HTML serializer class.
HtmlSerializer() - Constructor for class io.aalam.common.serializers.HtmlSerializer
 
HTTP_DATE_FORMAT - Static variable in class io.aalam.common.StaticsHandler
 
HttpClient - Class in io.aalam.common
 
HttpClient() - Constructor for class io.aalam.common.HttpClient
 
HttpException - Exception in io.aalam.common
The http exception objects are thrown by the action handler when it wishes to abort the processing when it faces an error.
HttpException(HttpResponseStatus, String) - Constructor for exception io.aalam.common.HttpException
Initialize the Exception with appropriate status code and a message
HttpPostProcessor - Class in io.aalam.common
 
HttpPostProcessor() - Constructor for class io.aalam.common.HttpPostProcessor
 
HttpPrePostProcessor - Class in io.aalam.common
 
HttpPrePostProcessor() - Constructor for class io.aalam.common.HttpPrePostProcessor
 
HttpPreProcessor - Class in io.aalam.common
 
HttpPreProcessor() - Constructor for class io.aalam.common.HttpPreProcessor
 
HttpRequest - Class in io.aalam.common
Class to access the request details.
HttpRequest(HttpVersion, HttpMethod, String, ByteBuf) - Constructor for class io.aalam.common.HttpRequest
Application code will not have any use with the constructors as the application code will always process on an initialized request object.
HttpRequest(FullHttpRequest) - Constructor for class io.aalam.common.HttpRequest
 
HttpRequest.Auth - Class in io.aalam.common
The authentication parameters for a request.
HttpResponse - Class in io.aalam.common
 
HttpResponse(HttpRequest, HttpVersion, HttpResponseStatus, ByteBuf) - Constructor for class io.aalam.common.HttpResponse
Initialize a new response object
HttpResponse(HttpRequest, HttpVersion, HttpResponseStatus) - Constructor for class io.aalam.common.HttpResponse
Initialize a new response object that has no data
HttpServer - Class in io.aalam.common
 
HttpServer() - Constructor for class io.aalam.common.HttpServer
 
HttpServerInitializer - Class in io.aalam.common
 
HttpServerInitializer() - Constructor for class io.aalam.common.HttpServerInitializer
 

I

initChannel(Channel) - Method in class io.aalam.common.HttpServerInitializer
 
internalServerError(String) - Static method in exception io.aalam.common.HttpException
Returns an Exception object that returns response with status "500 Internal Server Error" and a custom message
internalServerError() - Static method in class io.aalam.common.HttpResponse
Returns a pre initialized response object with status code "500"
invoke(HttpRequest, String[]) - Method in class io.aalam.common.router.Route
 
io.aalam.common - package io.aalam.common
 
io.aalam.common.router - package io.aalam.common.router
 
io.aalam.common.serializers - package io.aalam.common.serializers
 
isAnonymous() - Method in class io.aalam.common.HttpRequest.Auth
Check if the request is made by an unauthenticated source.
isClientAuthorized(HttpRequest, String, String) - Static method in class io.aalam.common.Role
Check if the user request a URL has permission
isCookie() - Method in class io.aalam.common.HttpRequest.Auth
Check if the request is made by a human user identified by HTTP cookies
isExternalServer() - Method in class io.aalam.common.HttpRequest.Auth
Check if the request made from external source
isInternal() - Method in class io.aalam.common.HttpRequest.Auth
Check if the request made by other applications
isUserAdmin(String) - Static method in class io.aalam.common.Role
Check if the requesting user is an admin
isUserAdmin(HttpRequest) - Static method in class io.aalam.common.Role
Check if the requesting user is an admin

J

JsonSerializer - Class in io.aalam.common.serializers
An abstract JSON serializer class.
JsonSerializer() - Constructor for class io.aalam.common.serializers.JsonSerializer
 

L

Launcher - Class in io.aalam.common
 
Launcher() - Constructor for class io.aalam.common.Launcher
 

M

main(String[]) - Static method in class io.aalam.common.Launcher
 
Mapper - Class in io.aalam.common.router
 
Mapper() - Constructor for class io.aalam.common.router.Mapper
The constructor will be used only by the framework.
Mapper.SubMapper - Class in io.aalam.common.router
Submapper class for the mapper object.
match(HttpRequest) - Method in class io.aalam.common.router.Mapper
This method is used by the framework.
match(HttpRequest) - Method in class io.aalam.common.router.Route
 
message - Variable in exception io.aalam.common.HttpException
 
messagesMap - Static variable in class io.aalam.common.Config
Path to the messages map containing the application's message settings defined in it's pom.xml
methodName() - Method in class io.aalam.common.HttpRequest
Get the HTTP method
migrate(String) - Method in interface io.aalam.common.Callbacks
This callback is invoked as the first step for updating an application.
migrateCompleted() - Method in interface io.aalam.common.Callbacks
This callback is invoked on the new process that is running on state STATE_POST_MIGRATE.
mysqlUrl - Static variable in class io.aalam.common.Config
URL to the mysql database in the format mysql://username:password@hostname:port/database_name

N

newSection(String) - Static method in class io.aalam.common.Config
Application will have no use with this method.
notFound(String) - Static method in exception io.aalam.common.HttpException
Raise to return response with status "404 Not Found" and a custom message
notFound() - Static method in class io.aalam.common.HttpResponse
Returns a pre initialized response object with status code "404"

P

packageDir - Static variable in class io.aalam.common.Config
Application execution root path.
params() - Method in class io.aalam.common.HttpRequest
Returns the URL parameters.
parse(String) - Static method in class io.aalam.common.Config
Application will have no use with this method.
path() - Method in class io.aalam.common.HttpRequest
Returns the URL path, example, for url GET /aalam/base/users?param1=value&param2=value, the path will be /aalam/base/users
Permissions - Class in io.aalam.common
This class defines the permissions for urls and will an object of this class will be used for every URL registration.
Permissions() - Constructor for class io.aalam.common.Permissions
Intialize an empty permissions object
permissions() - Method in class io.aalam.common.router.Route
 
permissionsMap - Static variable in class io.aalam.common.Config
Path to the permissions map containing the application's permissions defined in it's pom.xml
privKey - Static variable in class io.aalam.common.Config
Path to the RSA private key used while communicating with other internal applications.
process(HttpRequest) - Method in class io.aalam.common.AppHandler
 
process(HttpRequest) - Method in class io.aalam.common.AuthHandler
 
process(HttpRequest) - Method in class io.aalam.common.AuthorizationHandler
 
process(HttpRequest) - Method in class io.aalam.common.HooksHandler
 
process(HttpResponse) - Method in class io.aalam.common.HooksHandler
 
process(HttpResponse) - Method in class io.aalam.common.HttpPostProcessor
 
process(HttpRequest) - Method in class io.aalam.common.HttpPrePostProcessor
 
process(HttpResponse) - Method in class io.aalam.common.HttpPrePostProcessor
 
process(HttpRequest) - Method in class io.aalam.common.HttpPreProcessor
 
process(HttpRequest) - Method in class io.aalam.common.RouterHandler
 
process(HttpRequest) - Method in class io.aalam.common.StaticsHandler
 
process(HttpResponse) - Method in class io.aalam.common.StaticsHandler
 
process(HttpRequest) - Method in class io.aalam.common.SystemHandler
 
processAfter(HttpRequest, HttpResponse) - Method in class io.aalam.common.HooksHandler
 
processBefore(HttpRequest) - Method in class io.aalam.common.HooksHandler
 
pubKey - Static variable in class io.aalam.common.Config
Path to the public key of this application.

R

Redis - Class in io.aalam.common
Class to access the redis instance of this application.
Redis() - Constructor for class io.aalam.common.Redis
 
redisUrl - Static variable in class io.aalam.common.Config
Url to the redis server.
render(HttpRequest, HttpResponse) - Method in class io.aalam.common.serializers.HtmlSerializer
This method is used to serialize data in HTML format
request(String, String, Map<String, String>, Map<String, String>, byte[]) - Static method in class io.aalam.common.HttpClient
 
requestLocalServer(String, String, Map<String, String>, String, byte[], String, String) - Static method in class io.aalam.common.Utils
Send a signed request to other internal applications.
requestLocalServer(String, String, Map<String, String>, String, byte[]) - Static method in class io.aalam.common.Utils
Send a signed request to other internal applications.
requestLocalServer(String, String, Map<String, String>) - Static method in class io.aalam.common.Utils
Send a signed request to other internal applications.
Role - Class in io.aalam.common
This class helps the application to check the authority of the user over a request resource.
Role() - Constructor for class io.aalam.common.Role
 
RoleCache - Class in io.aalam.common
Cache of all the permissions identifiers of the application
RoleCache() - Constructor for class io.aalam.common.RoleCache
 
Route - Class in io.aalam.common.router
 
Route(String, String[], Object, String, Permissions) - Constructor for class io.aalam.common.router.Route
 
route() - Method in class io.aalam.common.router.RouteMatch
 
routeMatch() - Method in class io.aalam.common.HttpRequest
Application will have no use with this method.
RouteMatch - Class in io.aalam.common.router
 
RouteMatch(Route, String[]) - Constructor for class io.aalam.common.router.RouteMatch
 
RouterHandler - Class in io.aalam.common
 
RouterHandler() - Constructor for class io.aalam.common.RouterHandler
 
routes(Mapper) - Method in interface io.aalam.common.Callbacks
This method is where the URL registration have to be done.
run() - Static method in class io.aalam.common.HttpServer
 

S

sections - Static variable in class io.aalam.common.Config
 
sendResponse(ChannelHandlerContext, HttpRequest, Object) - Method in class io.aalam.common.AppHandler
 
sendResponse(ChannelHandlerContext, HttpRequest, HttpResponseStatus, Object) - Method in class io.aalam.common.HttpPrePostProcessor
 
sendResponse(ChannelHandlerContext, HttpRequest, Object) - Method in class io.aalam.common.HttpPrePostProcessor
 
sendResponse(ChannelHandlerContext, HttpRequest, HttpResponseStatus, Object) - Method in class io.aalam.common.HttpPreProcessor
 
sendResponse(ChannelHandlerContext, HttpRequest, Object) - Method in class io.aalam.common.HttpPreProcessor
 
serialize(HttpRequest, HttpResponse) - Method in interface io.aalam.common.Serializer
This method should set the response data in the response and the neccessary modifications in the response headers.
serialize(HttpRequest, HttpResponse) - Method in class io.aalam.common.serializers.HtmlSerializer
 
serialize(HttpRequest, HttpResponse) - Method in class io.aalam.common.serializers.JsonSerializer
 
Serializer - Interface in io.aalam.common
The data serializer used in general to serialize the response content.
server() - Static method in class io.aalam.common.Launcher
 
setAnonymousAuth() - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setContent(byte[]) - Method in class io.aalam.common.HttpResponse
Set the data be sent in the response.
setContent(ByteBuf) - Method in class io.aalam.common.HttpResponse
 
setContentType(String) - Method in class io.aalam.common.HttpResponse
Set the content type of the response data
setCookieAuth(String, Integer) - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setCookieAuth(String) - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setExternalAuth(String) - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setExternalAuth(String, String, Integer) - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setHttpRequest(HttpRequest) - Method in class io.aalam.common.HttpResponse
Sets the request object for which this response is being sent
setInternalAuth(String, String) - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setRouteMatch(RouteMatch) - Method in class io.aalam.common.HttpRequest
Application will have no use with this method.
setStaticInfo(String, String) - Method in class io.aalam.common.HttpRequest
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.
settingsMap - Static variable in class io.aalam.common.Config
Path to the settings map containing the application's settings items, defined in it's pom.xml
setTokenAuth(String) - Method in class io.aalam.common.HttpRequest
This method will be used by the framework internally.
setUserPermissions(HashSet<Integer>) - Method in class io.aalam.common.HttpRequest
Application will have no use with this method.
signAndSend(String, String, String, String, String, Map<String, String>, String, byte[], String) - Static method in class io.aalam.common.Utils
Send a signed request.
state - Static variable in class io.aalam.common.Launcher
 
STATE_MIGRATE - Static variable in interface io.aalam.common.Callbacks
This state means the application is getting upgraded and this is the first call to the upgradation process.
STATE_POST_MIGRATE - Static variable in interface io.aalam.common.Callbacks
This state means the application is getting upgraded and this is the final stage of the upgradation process.
STATE_RESTARTED - Static variable in interface io.aalam.common.Callbacks
This state means the application is restarted after recovering from a crash.
STATE_STARTED - Static variable in interface io.aalam.common.Callbacks
When an application is started in this state, it means the application is started afresh.
STATE_VALIDATION - Static variable in interface io.aalam.common.Callbacks
This is called mostly from the packager which does the package validation.
StaticsHandler - Class in io.aalam.common
 
StaticsHandler() - Constructor for class io.aalam.common.StaticsHandler
 
staticsUrlRoot - Static variable in class io.aalam.common.Config
The statics url prefix of the application as defined in it's pom.xml
status - Variable in exception io.aalam.common.HttpException
 
statusCode() - Method in class io.aalam.common.HttpResponse
Get the status code set on this response object
StatusTuple - Class in io.aalam.common
An object of this class will be returned by the action handler if it wants to set a status code with a response data
StatusTuple(HttpResponseStatus, Object) - Constructor for class io.aalam.common.StatusTuple
Constructor to set the response status and the data
subMapper(Object) - Method in class io.aalam.common.router.Mapper
Returns a new sub mapper object.
SubMapper(Mapper, Object) - Constructor for class io.aalam.common.router.Mapper.SubMapper
 
SystemHandler - Class in io.aalam.common
 
SystemHandler() - Constructor for class io.aalam.common.SystemHandler
 

T

toJson(HttpRequest, HttpResponse) - Method in class io.aalam.common.serializers.JsonSerializer
This method is used to serialize data in JSON format

U

unAuthorized(String) - Static method in exception io.aalam.common.HttpException
Returns an Exception object that returns response with status "404 Not Found" and a custom message
unAuthorized() - Static method in class io.aalam.common.HttpResponse
Returns a pre initialized response object with status code "401"
userId() - Method in class io.aalam.common.HttpRequest.Auth
ID of the user if obtained
userKeysPath - Static variable in class io.aalam.common.Config
The path to public keys of the users.
userPermissions() - Method in class io.aalam.common.HttpRequest
Get the permissions of the user initiating this request
Utils - Class in io.aalam.common
Utility functions of this framework
Utils() - Constructor for class io.aalam.common.Utils
 

V

values() - Method in class io.aalam.common.router.RouteMatch
 

W

WSGI_SOCKET_ROOT - Static variable in class io.aalam.common.HttpServer
 

_

_checkCache(HttpRequest, HttpResponse, String, String) - Method in class io.aalam.common.StaticsHandler
 
A B C D E F G H I J L M N P R S T U V W _ 
Skip navigation links

Copyright © 2017. All rights reserved.