Package de.xima.fc.interfaces.plugin.param.form

Interface IFormLifecycleExecuteParams

All Superinterfaces:
Serializable
All Known Subinterfaces:
IPluginFormPrePersistParams, IPluginFormPreProcessParams, IPluginFormPreRenderParams, IPluginFormPreRespondParams
All Known Implementing Classes:
PluginFormPrePersistParams, PluginFormPreProcessParams, PluginFormPreRenderParams, PluginFormPreRespondParams
public interface IFormLifecycleExecuteParams extends Serializable
Parameters passed to form lifecycle plugins when they are executed.
Since:
7.4.0
Author:
XIMA MEDIA GmbH

  • Method Details

    • getFormRequestContext

      IFormRequestContext getFormRequestContext()
      Returns:
      The current form request context that may be used to access the submitted form data.

    • getFrqSessionAttributeMap

      Map<Serializable,Serializable> getFrqSessionAttributeMap()
      Gets the values stored in the current FRQSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the FRQSession. To modify the FRQ session attributes, use the IPluginFormPrePersistRetVal.getFrqSessionAttributeMap() return value.
      Returns:
      Attributes from the form request session of the current request. If no such session exists, this is an empty map.

    • getLdapUserData

      com.alibaba.fastjson.JSONObject getLdapUserData()
      Returns:
      A JSONObject with the current LDAP data for the authenticated user. When the current form does not require authorization, or when the current user did not authorize via LDAP, this may return an empty JSONObject
      Since:
      6.2

    • getSessionAttributeMap

      Map<String,Serializable> getSessionAttributeMap()
      Gets the values from the current HttpSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the HttpSession. To modify the session attributes, use the IPluginFormPreRenderRetVal.getSessionAttributes() return value.
      Returns:
      A map Map with all attributes of the current HttpSession.

    • getUserData

      com.alibaba.fastjson.JSONObject getUserData()
      Returns:
      A JSONObject with the current data for the authenticated user. When the current form does not require authorization, this may return an empty JSONObject