org.gael.core.srv

Class Task

java.lang.Object

org.gael.core.srv.Task

Direct Known Subclasses:

GaelAdmin, GaelBesuTask, GaelLogon, GaelPrepareTenantSpace, GaelPrimeServer, GaelStatus, GaelViewDatastore

public class Task
extends java.lang.Object

Design Notes: The intent is that all Datastore changes are performed by these tasks that sub-class off of Task. In this way the algorithms that update the Datastore are controlled in one place. Each task is passed only the parameters it needs to perform its task. In this way various parts of the system can make changes from various contexts. All tasks implement a create function that creates the task object and optionally performs validation. It would set the bInvalid state if the create is not valid. By default all tasks should override execTokenReq, an exec function that carries out the task. The system will find and validate the token which can control what functions are allowed. If no token is found the request failes (404). If requiresToken is overriden to return a false execReq is called instead with no token check. Bothe execTokenReq and execToken behave the same. They return a result String (stringified JSON object) if the call was successful. They return a null to indicate failure with no result. With failure it is assumed that the nFailCode and sFailText values are set. The nFailCode s/b a suitable value from the HTTP status code setting. The sFailText s/b a short message with more information. These fail codes are then relayed to the appropriate context that can report the error.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Task.AnsJson
static class	Task.AnsJWire
static class	Task.AnsSoftFail
static class	Task.AnsTask
static class	Task.Fail
static class	Task.HasToken
static class	Task.NoToken
static class	Task.Payload
static class	Task.PayloadJson

Field Summary

Fields

Modifier and Type	Field and Description
boolean	bDevp
Gson	gson
JsonObject	oJR

Constructor Summary

Constructors

Constructor and Description
Task()

Method Summary

Modifier and Type	Method and Description
Task.AnsTask	abort(Req oR, Task.Fail eFailCode, java.lang.String sFailText)
void	addBriefMsg(java.lang.String msg)
boolean	canAcceptExecReq(Req oR)
boolean	canAcceptVirginState()
java.lang.Exception	e(java.lang.String err)
Task.AnsTask	execLegReq(Req oR)
Task.AnsTask	execLegTokenReq(Req oR, TokenMgr.Token oTok)
JWired	execReq(Req oR)
JWired	execTokenReq(Req oR, TokenMgr.Token oTok)
JWired	failed(Req oR, Task.Fail eFailCode, java.lang.String sFailText)
java.lang.String	getCustEncoder()
java.lang.String	getExecReq(Req oR)
long	getTS()
java.lang.String	goodAns(JsonObject oJR, java.lang.String sJsonAns)
java.lang.String	goodAns(JsonObject oJR, java.lang.String sJsonAns, java.lang.String sFailCode)
boolean	isDevp()
void	log(java.lang.String sMsg)
java.lang.String[]	makeBriefMsgs()
<T> T	payload(Req oR, java.lang.Class<T> T)
java.lang.String	payloadAsStr(java.lang.Object oPL)
boolean	requiresToken()
Task	setCustEncoder(java.lang.String sCustEncoder)
JWired	softFail(JWired oParAns, java.lang.String sWhy)
<T> T	wire2obj(Req oR, java.lang.Class<T> T)

Methods inherited from class java.lang.Object

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

Field Detail

bDevp

public boolean bDevp

oJR

public JsonObject oJR

gson

public Gson gson

Constructor Detail

Task

public Task()

Method Detail

softFail

public JWired softFail(JWired oParAns,
                       java.lang.String sWhy)

log

public void log(java.lang.String sMsg)

getTS

public long getTS()

isDevp

public boolean isDevp()

setCustEncoder

public Task setCustEncoder(java.lang.String sCustEncoder)

getCustEncoder

public java.lang.String getCustEncoder()

getExecReq

public java.lang.String getExecReq(Req oR)

addBriefMsg

public void addBriefMsg(java.lang.String msg)

makeBriefMsgs

public java.lang.String[] makeBriefMsgs()

payload

public <T> T payload(Req oR,
                     java.lang.Class<T> T)
              throws java.lang.Exception

Throws:

java.lang.Exception

goodAns

public java.lang.String goodAns(JsonObject oJR,
                                java.lang.String sJsonAns)

goodAns

public java.lang.String goodAns(JsonObject oJR,
                                java.lang.String sJsonAns,
                                java.lang.String sFailCode)

canAcceptVirginState

public boolean canAcceptVirginState()

requiresToken

public boolean requiresToken()

canAcceptExecReq

public boolean canAcceptExecReq(Req oR)

execLegReq

public Task.AnsTask execLegReq(Req oR)
                        throws java.lang.Exception

Throws:

java.lang.Exception

execLegTokenReq

public Task.AnsTask execLegTokenReq(Req oR,
                                    TokenMgr.Token oTok)
                             throws java.lang.Exception

Throws:

java.lang.Exception

execReq

public JWired execReq(Req oR)
               throws java.lang.Exception

Throws:

java.lang.Exception

execTokenReq

public JWired execTokenReq(Req oR,
                           TokenMgr.Token oTok)
                    throws java.lang.Exception

Throws:

java.lang.Exception

e

public java.lang.Exception e(java.lang.String err)

abort

public Task.AnsTask abort(Req oR,
                          Task.Fail eFailCode,
                          java.lang.String sFailText)
                   throws java.lang.Exception

Throws:

java.lang.Exception

failed

public JWired failed(Req oR,
                     Task.Fail eFailCode,
                     java.lang.String sFailText)
              throws java.lang.Exception

Throws:

java.lang.Exception

wire2obj

public <T> T wire2obj(Req oR,
                      java.lang.Class<T> T)
               throws java.lang.Exception

Throws:

java.lang.Exception

payloadAsStr

public java.lang.String payloadAsStr(java.lang.Object oPL)