act.app

Class ActionContext

java.lang.Object

act.util.DestroyableBase

act.util.ActContext.Base<ActionContext>

act.app.ActionContext

All Implemented Interfaces:

Destroyable, ActContext<ActionContext>, org.osgl.mvc.util.ParamValueProvider

@RequestScoped
public class ActionContext
extends ActContext.Base<ActionContext>
implements Destroyable

AppContext encapsulate contextual properties needed by an application session

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ActionContext.ActionContextEvent
static class	ActionContext.PreFireSessionResolvedEvent This event is fired after session resolved and before any SessionManager.Listener get called
static class	ActionContext.SessionDissolvedEvent
static class	ActionContext.SessionResolvedEvent This event is fired after session resolved and after all SessionManager.Listener get notified and in turn after all event listeners that listen to the ActionContext.PreFireSessionResolvedEvent get notified
static class	ActionContext.SessionWillDissolveEvent
static class	ActionContext.State

Nested classes/interfaces inherited from interface act.Destroyable

Destroyable.Util

Nested classes/interfaces inherited from interface act.util.ActContext

ActContext.Base<CTX extends ActContext.Base>, ActContext.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_CSR_TOKEN_PREFETCH
static String	ATTR_CSRF_TOKEN
static String	ATTR_CURRENT_FILE_INDEX
static String	ATTR_EXCEPTION
static String	ATTR_HANDLER
static String	ATTR_PATH_VARS
static String	ATTR_RESULT
static String	ATTR_WAS_UNAUTHENTICATED
static String	METHOD_GET_CURRENT
static String	REQ_BODY

Method Summary

Modifier and Type	Method and Description
List<String>	__appRenderArgNames()
ActionContext	__appRenderArgNames(String names) Called by bytecode enhancer to set the name list of the render arguments that is update by the enhancer
Object	__controllerInstance(String className)
ActionContext	__controllerInstance(String className, Object instance)
org.osgl.http.H.Format	accept()
ActionContext	accept(org.osgl.http.H.Format fmt)
boolean	acceptJson()
boolean	acceptXML()
String	actionPath()
ActionContext	actionPath(String path)
ActionContext	addUpload(String name, org.osgl.storage.ISObject sobj)
Map<String,String[]>	allParams()
ActionContext	applyContentType()
ActionContext	applyCorsSpec()
String	body()
org.osgl.util.S.Buffer	buildViolationMessage(org.osgl.util.S.Buffer builder)
org.osgl.util.S.Buffer	buildViolationMessage(org.osgl.util.S.Buffer builder, String separator)
void	cache(String key, Object obj) Add an object into cache by key.
void	cache(String key, Object obj, int expiration) Add an object into cache by key with expiration time specified
<T> T	cached(String key) Return cached object by key.
void	cacheForHalfHour(String key, Object obj) Add an object into cache by key and expired after half hour
void	cacheForOneHour(String key, Object obj) Add an object into cache by key and expired after one hour
void	cacheForOneMinute(String key, Object obj) Add an object into cache by key and expired after one minute
void	cacheForTenMinutes(String key, Object obj) Add an object into cache by key and expired after 10 minutes
void	checkCsrf(org.osgl.http.H.Session session)
static void	clearCurrent()
static void	clearLocal()
org.osgl.http.H.Cookie	cookie(String name)
static ActionContext	create(App app, org.osgl.http.H.Request request, org.osgl.http.H.Response resp) Create an new AppContext and return the new instance
MissingAuthenticationHandler	csrfFailureHandler()
static ActionContext	current()
void	disableCORS()
void	dissolve() Dissolve session and flash into cookies.
ActionContext	enableCache()
void	evictCache(String key) Evict cached object
org.osgl.http.H.Flash	flash()
String	flash(String key)
org.osgl.http.H.Flash	flash(String key, String value)
ActionContext	flashViolationMessage()
ActionContext	flashViolationMessage(String separator)
ActionContext	forceCsrfCheckingFailureHandler(MissingAuthenticationHandler handler)
ActionContext	forceMissingAuthenticationHandler(MissingAuthenticationHandler handler)
ActionContext	forceResponseStatus(org.osgl.http.H.Status status)
RequestHandler	handler()
ActionContext	handler(RequestHandler handler)
Boolean	hasTemplate()
boolean	isAjax()
boolean	isLoggedIn()
boolean	isOptionsMethod()
boolean	isSessionDissolved()
boolean	isSessionResolved()
boolean	jsonEncoded()
Locale	locale(boolean required)
void	login(String username) Update the context session to mark a user logged in
void	logout() Logout the current session.
String	methodPath()
MissingAuthenticationHandler	missingAuthenticationHandler()
org.osgl.mvc.result.Result	nullValueResult()
org.osgl.mvc.result.Result	nullValueResultIgnoreRenderArgs()
ActionContext	param(String name, String value)
Set<String>	paramKeys()
String	paramVal(String name)
String[]	paramVals(String name)
int	port()
String	portId()
void	preCheckCsrf()
protected void	releaseResources() Clear all internal data store/cache and then remove this context from thread local
<T> T	renderArg(String name)
ActionContext	renderArg(String name, Object val)
Map<String,Object>	renderArgs() Returns all render arguments
org.osgl.http.H.Request	req()
void	resolve() Initialize params/renderArgs/attributes and then resolve session and flash from cookies
org.osgl.http.H.Response	resp()
Router	router()
ActionContext	router(Router router)
void	saveLocal()
org.osgl.http.H.Session	session()
String	session(String key)
org.osgl.http.H.Session	session(String key, String value)
void	setCsrfCookieAndRenderArgs()
ActionContext	setHasTemplate(boolean b)
void	startHandling()
void	startIntercepting()
ActionContext.State	state()
org.osgl.http.H.Status	successStatus()
ActionContext	templatePath(String templatePath) Set path to template file
org.osgl.storage.ISObject	upload(String name)
org.osgl.storage.ISObject	upload(String name, int index)
String	urlContext()
ActionContext	urlContext(String context)
org.osgl.web.util.UserAgent	userAgent()
String	username()
String	violationMessage()
String	violationMessage(String separator)

Methods inherited from class act.util.ActContext.Base

_act_i18n, addDestroyable, addListener, addViolation, addViolations, app, attribute, attribute, attributes, cachedTemplate, cacheTemplate, config, currentContext, currentContextType, fieldOutputVarCount, fieldOutputVarCount, hasRenderArgs, hasViolation, i18n, i18n, i18n, i18n, i18n, i18n, i18n, i18n, i18n, i18n, locale, locale, me, removeAttribute, strBuf, templateContext, templateContext, templatePath, templatePathIsImplicit, violation, violations

Methods inherited from class act.util.DestroyableBase

addSubResource, destroy, isDestroyed, reload, scope

Methods inherited from class java.lang.Object

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

Methods inherited from interface act.Destroyable

destroy, isDestroyed, scope

Field Detail

ATTR_CSRF_TOKEN

public static final String ATTR_CSRF_TOKEN

See Also:

Constant Field Values

ATTR_CSR_TOKEN_PREFETCH

public static final String ATTR_CSR_TOKEN_PREFETCH

See Also:

Constant Field Values

ATTR_WAS_UNAUTHENTICATED

public static final String ATTR_WAS_UNAUTHENTICATED

See Also:

Constant Field Values

ATTR_HANDLER

public static final String ATTR_HANDLER

See Also:

Constant Field Values

ATTR_PATH_VARS

public static final String ATTR_PATH_VARS

See Also:

Constant Field Values

ATTR_RESULT

public static final String ATTR_RESULT

See Also:

Constant Field Values

ATTR_EXCEPTION

public static final String ATTR_EXCEPTION

See Also:

Constant Field Values

ATTR_CURRENT_FILE_INDEX

public static final String ATTR_CURRENT_FILE_INDEX

See Also:

Constant Field Values

REQ_BODY

public static final String REQ_BODY

See Also:

Constant Field Values

METHOD_GET_CURRENT

public static final String METHOD_GET_CURRENT

See Also:

Constant Field Values

Method Detail

state

public ActionContext.State state()

isSessionDissolved

public boolean isSessionDissolved()

isSessionResolved

public boolean isSessionResolved()

req

public org.osgl.http.H.Request req()

resp

public org.osgl.http.H.Response resp()

cookie

public org.osgl.http.H.Cookie cookie(String name)

session

public org.osgl.http.H.Session session()

session

public String session(String key)

session

public org.osgl.http.H.Session session(String key,
                                       String value)

flash

public org.osgl.http.H.Flash flash()

flash

public String flash(String key)

flash

public org.osgl.http.H.Flash flash(String key,
                                   String value)

router

public Router router()

router

public ActionContext router(Router router)

missingAuthenticationHandler

public MissingAuthenticationHandler missingAuthenticationHandler()

csrfFailureHandler

public MissingAuthenticationHandler csrfFailureHandler()

forceMissingAuthenticationHandler

public ActionContext forceMissingAuthenticationHandler(MissingAuthenticationHandler handler)

forceCsrfCheckingFailureHandler

public ActionContext forceCsrfCheckingFailureHandler(MissingAuthenticationHandler handler)

urlContext

public ActionContext urlContext(String context)

urlContext

public String urlContext()

renderArg

public <T> T renderArg(String name)

Specified by:

renderArg in interface ActContext<ActionContext>

Overrides:

renderArg in class ActContext.Base<ActionContext>

renderArg

public ActionContext renderArg(String name,
                               Object val)

Specified by:

renderArg in interface ActContext<ActionContext>

Overrides:

renderArg in class ActContext.Base<ActionContext>

renderArgs

public Map<String,Object> renderArgs()

Description copied from interface: ActContext

Returns all render arguments

Specified by:

renderArgs in interface ActContext<ActionContext>

Overrides:

renderArgs in class ActContext.Base<ActionContext>

templatePath

public ActionContext templatePath(String templatePath)

Description copied from interface: ActContext

Set path to template file

Specified by:

templatePath in interface ActContext<ActionContext>

Overrides:

templatePath in class ActContext.Base<ActionContext>

Parameters:

templatePath - the path to template file

Returns:

this AppContext

handler

public RequestHandler handler()

handler

public ActionContext handler(RequestHandler handler)

accept

public org.osgl.http.H.Format accept()

Specified by:

accept in interface ActContext<ActionContext>

accept

public ActionContext accept(org.osgl.http.H.Format fmt)

Specified by:

accept in interface ActContext<ActionContext>

hasTemplate

public Boolean hasTemplate()

setHasTemplate

public ActionContext setHasTemplate(boolean b)

enableCache

public ActionContext enableCache()

portId

public String portId()

port

public int port()

userAgent

public org.osgl.web.util.UserAgent userAgent()

jsonEncoded

public boolean jsonEncoded()

acceptJson

public boolean acceptJson()

acceptXML

public boolean acceptXML()

isAjax

public boolean isAjax()

isOptionsMethod

public boolean isOptionsMethod()

username

public String username()

isLoggedIn

public boolean isLoggedIn()

body

public String body()

param

public ActionContext param(String name,
                           String value)

paramKeys

public Set<String> paramKeys()

Specified by:

paramKeys in interface org.osgl.mvc.util.ParamValueProvider

paramVal

public String paramVal(String name)

Specified by:

paramVal in interface org.osgl.mvc.util.ParamValueProvider

paramVals

public String[] paramVals(String name)

Specified by:

paramVals in interface org.osgl.mvc.util.ParamValueProvider

allParams

public Map<String,String[]> allParams()

upload

public org.osgl.storage.ISObject upload(String name)

upload

public org.osgl.storage.ISObject upload(String name,
                                        int index)

addUpload

public ActionContext addUpload(String name,
                               org.osgl.storage.ISObject sobj)

successStatus

public org.osgl.http.H.Status successStatus()

forceResponseStatus

public ActionContext forceResponseStatus(org.osgl.http.H.Status status)

nullValueResult

public org.osgl.mvc.result.Result nullValueResult()

nullValueResultIgnoreRenderArgs

public org.osgl.mvc.result.Result nullValueResultIgnoreRenderArgs()

preCheckCsrf

public void preCheckCsrf()

checkCsrf

public void checkCsrf(org.osgl.http.H.Session session)

setCsrfCookieAndRenderArgs

public void setCsrfCookieAndRenderArgs()

disableCORS

public void disableCORS()

applyContentType

public ActionContext applyContentType()

applyCorsSpec

public ActionContext applyCorsSpec()

__appRenderArgNames

public ActionContext __appRenderArgNames(String names)

Called by bytecode enhancer to set the name list of the render arguments that is update by the enhancer

Parameters:

names - the render argument names separated by “,”

Returns:

this AppContext

__appRenderArgNames

public List<String> __appRenderArgNames()

__controllerInstance

public ActionContext __controllerInstance(String className,
                                          Object instance)

__controllerInstance

public Object __controllerInstance(String className)

cached

public <T> T cached(String key)

Return cached object by key. The key will be concatenated with current session id when fetching the cached object

Type Parameters:

T - the object type

Parameters:

key -

Returns:

the cached object

cache

public void cache(String key,
                  Object obj)

Add an object into cache by key. The key will be used in conjunction with session id if there is a session instance

Parameters:

key - the key to index the object within the cache

obj - the object to be cached

cache

public void cache(String key,
                  Object obj,
                  int expiration)

Add an object into cache by key with expiration time specified

Parameters:

key - the key to index the object within the cache

obj - the object to be cached

expiration - the seconds after which the object will be evicted from the cache

cacheForOneHour

public void cacheForOneHour(String key,
                            Object obj)

Add an object into cache by key and expired after one hour

Parameters:

key - the key to index the object within the cache

obj - the object to be cached

cacheForHalfHour

public void cacheForHalfHour(String key,
                             Object obj)

Add an object into cache by key and expired after half hour

Parameters:

key - the key to index the object within the cache

obj - the object to be cached

cacheForTenMinutes

public void cacheForTenMinutes(String key,
                               Object obj)

Add an object into cache by key and expired after 10 minutes

Parameters:

key - the key to index the object within the cache

obj - the object to be cached

cacheForOneMinute

public void cacheForOneMinute(String key,
                              Object obj)

Add an object into cache by key and expired after one minute

Parameters:

key - the key to index the object within the cache+

obj - the object to be cached

evictCache

public void evictCache(String key)

Evict cached object

Parameters:

key - the key indexed the cached object to be evicted

buildViolationMessage

public org.osgl.util.S.Buffer buildViolationMessage(org.osgl.util.S.Buffer builder)

buildViolationMessage

public org.osgl.util.S.Buffer buildViolationMessage(org.osgl.util.S.Buffer builder,
                                                    String separator)

violationMessage

public String violationMessage(String separator)

violationMessage

public String violationMessage()

flashViolationMessage

public ActionContext flashViolationMessage()

flashViolationMessage

public ActionContext flashViolationMessage(String separator)

actionPath

public String actionPath()

actionPath

public ActionContext actionPath(String path)

methodPath

public String methodPath()

Specified by:

methodPath in interface ActContext<ActionContext>

startIntercepting

public void startIntercepting()

startHandling

public void startHandling()

login

public void login(String username)

Update the context session to mark a user logged in

Parameters:

username - the username

logout

public void logout()

Logout the current session. After calling this method, the session will be cleared

resolve

public void resolve()

Initialize params/renderArgs/attributes and then resolve session and flash from cookies

locale

public Locale locale(boolean required)

Specified by:

locale in interface ActContext<ActionContext>

Overrides:

locale in class ActContext.Base<ActionContext>

dissolve

public void dissolve()

Dissolve session and flash into cookies.

Note this method must be called before any content has been committed to response output stream/writer

releaseResources

protected void releaseResources()

Clear all internal data store/cache and then remove this context from thread local

Overrides:

releaseResources in class ActContext.Base<ActionContext>

saveLocal

public void saveLocal()

clearLocal

public static void clearLocal()

current

public static ActionContext current()

clearCurrent

public static void clearCurrent()

create

public static ActionContext create(App app,
                                   org.osgl.http.H.Request request,
                                   org.osgl.http.H.Response resp)

Create an new AppContext and return the new instance