Package org.apache.ofbiz.common.scripting

Class ContextHelper

java.lang.Object
org.apache.ofbiz.common.scripting.ContextHelper
public final class ContextHelper extends Object
A set of ScriptContext convenience methods for scripting engines.

  • Constructor Details

  • Method Details

    • addBinding

      public Object addBinding(String key, Object value)

    • expandString

      public String expandString(String original)
      Expands environment variables delimited with ${}

    • getBindings

      public Map<String,Object> getBindings()

    • getDelegator

      public Delegator getDelegator()

    • getDispatcher

      public LocalDispatcher getDispatcher()

    • getEnv

      public <T> T getEnv(FlexibleMapAccessor<T> fma)

    • getEnv

      public <T> T getEnv(String key)
      Gets the named value from the environment. Supports the "." (dot) syntax to access Map members and the "[]" (bracket) syntax to access List entries. This value is expanded, supporting the insertion of other environment values using the "${}" notation.
      Parameters:
      key - The name of the environment value to get. Can contain "." and "[]" syntax elements as described above.
      Returns:
      The environment value if found, otherwise null.

    • getErrorMessages

      public List<String> getErrorMessages()

    • getEnvEntryIterator

      public Iterator<Map.Entry<String,Object>> getEnvEntryIterator()

    • getLocale

      public Locale getLocale()

    • getVisualTheme

      public VisualTheme getVisualTheme()

    • getParameter

      public Object getParameter(String key)

    • getParameters

      public Map<String,Object> getParameters()

    • getRequest

      public HttpServletRequest getRequest()

    • getResponse

      public HttpServletResponse getResponse()

    • getResult

      public Object getResult(String key)

    • getResults

      public Map<String,Object> getResults()

    • getScriptName

      public String getScriptName()

    • getSecurity

      public Security getSecurity()

    • getTimeZone

      public TimeZone getTimeZone()

    • getUserLogin

      public GenericValue getUserLogin()

    • isEvent

      public boolean isEvent()

    • isService

      public boolean isService()

    • putAllEnv

      public void putAllEnv(Map<String,? extends Object> values)
      Calls putEnv for each entry in the Map, thus allowing for the additional flexibility in naming supported in that method.

    • putEnv

      public <T> void putEnv(FlexibleMapAccessor<T> fma, T value)

    • putEnv

      public <T> void putEnv(String key, T value)
      Puts the named value in the environment. Supports the "." (dot) syntax to access Map members and the "[]" (bracket) syntax to access List entries. If the brackets for a list are empty the value will be appended to end of the list, otherwise the value will be set in the position of the number in the brackets. If a "+" (plus sign) is included inside the square brackets before the index number the value will inserted/added at that index instead of set at that index. This value is expanded, supporting the insertion of other environment values using the "${}" notation.
      Parameters:
      key - The name of the environment value to get. Can contain "." syntax elements as described above.
      value - The value to set in the named environment location.

    • putParameter

      public void putParameter(String key, Object value)

    • putResult

      public void putResult(String key, Object value)

    • putResults

      public void putResults(Map<String,Object> results)

    • removeBinding

      public Object removeBinding(String key)

    • removeEnv

      public <T> T removeEnv(FlexibleMapAccessor<T> fma)

    • removeEnv

      public <T> T removeEnv(String key)
      Removes the named value from the environment. Supports the "." (dot) syntax to access Map members and the "[]" (bracket) syntax to access List entries. This value is expanded, supporting the insertion of other environment values using the "${}" notation.
      Parameters:
      key - The name of the environment value to get. Can contain "." syntax elements as described above.

    • setUserLogin

      public void setUserLogin(GenericValue userLogin, String userLoginEnvName)