org.gael.core.srv

Class Router

java.lang.Object

HttpServlet

org.gael.core.srv.Router

public class Router
extends HttpServlet

Router extends the HttpServlet class and is the entry point for all GAEL server requests. The WEB.XML is used to point requests that need to be serviced by the Router class.
If the instance is not warm the InitInstance class is called.

All requests are routed to the RouteHandler implementor found through a lookup in the {link GAEL.Config#getHandler}

The request processor determines the Content-Type that is returned. The default is application/json since the majority of calls are of the Ajax variety (or close cousins) using a POST method.

Field Summary

Fields

Modifier and Type	Field and Description
static int	krGET
static int	krPOST
static int	krPUT
int	nCtr

Constructor Summary

Constructors

Constructor and Description
Router()

Method Summary

Modifier and Type	Method and Description
void	destroy() Not implemented.
void	doGet(HttpServletRequest oReq, HttpServletResponse oRes) Internally the request is routed to handleRequest where it is routed to the appropriate RouteHandler.
void	doPost(HttpServletRequest oReq, HttpServletResponse oRes) Internally the request is routed to handleRequest where it is routed to the appropriate RouteHandler.
void	init(ServletConfig oCfg) Called when the servlet needs initialization (on a cold start).
boolean	isDevp()
void	jsonOutput(HttpServletResponse oRes, java.lang.String sJsonStr) Called by RouteHandlers to create a application/json response.
void	log(java.lang.String sMsg)
void	sendResponseError(HttpServletRequest oReq, HttpServletResponse oRes, int nCode, java.lang.String sError) Used to send a failure code to the client
void	sendResponseError(Req oR, int nCode, java.lang.String sError) Used to send an error to the client
void	sendResponseErrorTrace(java.lang.Exception e, Req oR, HttpServletResponse oRes, int nCode, java.lang.String sError) Used to send an execption with trace information to the client

Methods inherited from class java.lang.Object

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

Field Detail

krGET

public static final int krGET

See Also:

Constant Field Values

krPOST

public static final int krPOST

See Also:

Constant Field Values

krPUT

public static final int krPUT

See Also:

Constant Field Values

nCtr

public int nCtr

Constructor Detail

Router

public Router()

Method Detail

log

public void log(java.lang.String sMsg)

isDevp

public boolean isDevp()

init

public void init(ServletConfig oCfg)
          throws ServletException

Called when the servlet needs initialization (on a cold start). In the App Engine environment in standard mode this happens when the server instance is closed down due to inactivity and then receives a request.

Parameters:

oCfg -

Throws:

ServletException - - when the InitInstance fails

doPost

public void doPost(HttpServletRequest oReq,
                   HttpServletResponse oRes)
            throws java.io.IOException

Internally the request is routed to handleRequest where it is routed to the appropriate RouteHandler.

Parameters:

oReq - Standard servlet request parameters

oRes - Standard servlet response parameters

Throws:

java.io.IOException

doGet

public void doGet(HttpServletRequest oReq,
                  HttpServletResponse oRes)
           throws java.io.IOException

Internally the request is routed to handleRequest where it is routed to the appropriate RouteHandler.

Parameters:

oReq - Standard servlet request parameters

oRes - Standard servlet response parameters

Throws:

java.io.IOException

jsonOutput

public void jsonOutput(HttpServletResponse oRes,
                       java.lang.String sJsonStr)
                throws java.io.IOException

Called by RouteHandlers to create a application/json response.

Parameters:

oRes - standard servlet response parameters

sJsonStr - JSON formatted string to be returned

Throws:

java.io.IOException

sendResponseError

public void sendResponseError(Req oR,
                              int nCode,
                              java.lang.String sError)
                       throws java.io.IOException

Used to send an error to the client

Parameters:

oR -

nCode -

sError -

Throws:

java.io.IOException

sendResponseError

public void sendResponseError(HttpServletRequest oReq,
                              HttpServletResponse oRes,
                              int nCode,
                              java.lang.String sError)
                       throws java.io.IOException

Used to send a failure code to the client

Parameters:

oReq -

oRes -

nCode -

sError -

Throws:

java.io.IOException

sendResponseErrorTrace

public void sendResponseErrorTrace(java.lang.Exception e,
                                   Req oR,
                                   HttpServletResponse oRes,
                                   int nCode,
                                   java.lang.String sError)
                            throws java.io.IOException

Used to send an execption with trace information to the client

Parameters:

e -

oR -

oRes -

nCode -

sError -

Throws:

java.io.IOException

destroy

public void destroy()

Not implemented. Does nothing.