Package org.jeyzer.publish

Class JzrActionContext

java.lang.Object

org.jeyzer.publish.JzrActionContext

All Implemented Interfaces:

Cloneable

public final class JzrActionContext
extends Object
implements Cloneable

The Jeyzer action context class is a bean representing the current action executed within one thread.
All its attributes are optional.
Non thread safe

Constructor Summary

Constructors

Constructor	Description
JzrActionContext()	The Jeyzer action context constructor
JzrActionContext(String id, String user, String functionPrincipal, Map<String,String> params)	The Jeyzer action context constructor

Method Summary

Modifier and Type	Method	Description
Object	clone()
Map<String,String>	getContextParams()	Get the context parameters.
String	getFunctionPrincipal()	Get the action function principal.
String	getId()	Get the applicative action id.
String	getUser()	Get the applicative user.
void	setContextParam(String key, String value)	Set a context parameter
void	setContextParams(Map<String,String> params)	Set the context parameters
void	setFunctionPrincipal(String functionPrincipal)	Set the action function principal
void	setId(String id)	Set the applicative action id
void	setUser(String user)	Set the applicative user

Methods inherited from class java.lang.Object

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

Constructor Detail

JzrActionContext

public JzrActionContext()

The Jeyzer action context constructor

JzrActionContext

public JzrActionContext(String id,
                        String user,
                        String functionPrincipal,
                        Map<String,String> params)

The Jeyzer action context constructor

Parameters:

id - the applicative action id. Can be null

user - the applicative user. Can be null

functionPrincipal - the action function principal. Can be null

params - the context parameters. Can be null

Method Detail

getId

public String getId()

Get the applicative action id. Can be null

Returns:

the applicative action id

setId

public void setId(String id)

Set the applicative action id

Parameters:

id - the applicative action id

getUser

public String getUser()

Get the applicative user. Can be null

Returns:

the applicative user

setUser

public void setUser(String user)

Set the applicative user

Parameters:

user - the applicative user

getFunctionPrincipal

public String getFunctionPrincipal()

Get the action function principal. Can be null

Returns:

the action function principal

setFunctionPrincipal

public void setFunctionPrincipal(String functionPrincipal)

Set the action function principal

Parameters:

functionPrincipal - the action function principal

getContextParams

public Map<String,String> getContextParams()

Get the context parameters. Can be null

Returns:

the context parameters

setContextParams

public void setContextParams(Map<String,String> params)

Set the context parameters

Parameters:

params - context parameters

setContextParam

public void setContextParam(String key,
                            String value)

Set a context parameter

Parameters:

key - the context parameter key

value - the context parameter value. Can be null

clone

public Object clone()

Overrides:

clone in class Object