Package org.jeyzer.publish

Class JzrActionContext

  • public final class JzrActionContext
extends java.lang.Object
    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​(java.lang.String id, java.lang.String user, java.lang.String functionPrincipal, java.util.Map<java.lang.String,​java.lang.String> params)
      The Jeyzer action context constructor
      JzrActionContext​(JzrActionContext context)
      The Jeyzer action context cloning constructor

    • Method Summary

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • JzrActionContext

        public JzrActionContext()
        The Jeyzer action context constructor

      • JzrActionContext

        public JzrActionContext​(java.lang.String id,
                        java.lang.String user,
                        java.lang.String functionPrincipal,
                        java.util.Map<java.lang.String,​java.lang.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

      • JzrActionContext

        public JzrActionContext​(JzrActionContext context)
        The Jeyzer action context cloning constructor
        Parameters:
        context - the context to clone

    • Method Detail

      • getId

        public java.lang.String getId()
        Get the applicative action id. Can be null
        Returns:
        the applicative action id

      • setId

        public void setId​(java.lang.String id)
        Set the applicative action id
        Parameters:
        id - the applicative action id

      • getUser

        public java.lang.String getUser()
        Get the applicative user. Can be null
        Returns:
        the applicative user

      • setUser

        public void setUser​(java.lang.String user)
        Set the applicative user
        Parameters:
        user - the applicative user

      • getFunctionPrincipal

        public java.lang.String getFunctionPrincipal()
        Get the action function principal. Can be null
        Returns:
        the action function principal

      • setFunctionPrincipal

        public void setFunctionPrincipal​(java.lang.String functionPrincipal)
        Set the action function principal
        Parameters:
        functionPrincipal - the action function principal

      • getContextParams

        public java.util.Map<java.lang.String,​java.lang.String> getContextParams()
        Get the context parameters. Can be null
        Returns:
        the context parameters

      • setContextParams

        public void setContextParams​(java.util.Map<java.lang.String,​java.lang.String> params)
        Set the context parameters
        Parameters:
        params - context parameters

      • setContextParam

        public void setContextParam​(java.lang.String key,
                            java.lang.String value)
        Set a context parameter
        Parameters:
        key - the context parameter key
        value - the context parameter value. Can be null