Package org.exoplatform.web.login

Interface UIParamsExtension

All Known Implementing Classes:
RegisterUIParamsExtension
public interface UIParamsExtension
An API for services willing to extend UI (basically based on JSP) with additional parameters. To extend the list of params, you can simply implement this interface and declare it as a Kernel Component.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    extendParameters(org.exoplatform.web.ControllerContext controllerContext, String extensionName)
    Returns the list of parameters to retrieve in Login UI for Login components
    List<String>
    getExtensionNames()
     

  • Method Details

    • getExtensionNames

      List<String> getExtensionNames()
      Returns:
      List of extension names that will be used to fill parameters

    • extendParameters

      Map<String,Object> extendParameters(org.exoplatform.web.ControllerContext controllerContext, String extensionName)
      Returns the list of parameters to retrieve in Login UI for Login components
      Parameters:
      controllerContext - ControllerContext that provides the current HttpServletRequest and HttpServletResponse
      extensionName - extension name that needs to extend the parameters
      Returns:
      List of Key/Value to add to Login JSON object params