Class LoginScreenHelper
java.lang.Object
org.nuxeo.ecm.platform.ui.web.auth.LoginScreenHelper
Simple helper class for easy access form the login.jsp page
- Since:
- 5.7
- Author:
- Tiry
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic LoginScreenConfig
protected static LoginStartupPage
Returns theLoginStartupPage
contribution with the highest priority ornull
if none is contributed.static boolean
getDisplayMobileBanner
(javax.servlet.http.HttpServletRequest request) Returns whether mobile app banner should be display or not.protected static PluggableAuthenticationService
static String
Returns the path of the startup page depending on theLoginScreenConfig
/LoginStartupPage
contributions to theloginScreen
extension point.Returns the paths of the startup pages coming from theLoginScreenConfig
/LoginStartupPage
contributions to theloginScreen
extension point.static String
getStartupPageURL
(javax.servlet.http.HttpServletRequest request) Returns the startup page URL according to the path returned bygetStartupPagePath()
.static String
getValueWithDefault
(String value, String defaultValue) static void
registerLoginProvider
(String name, String iconUrl, String link, String label, String description, LoginProviderLinkComputer computer) Deprecated.static LoginScreenConfig
registerSingleProviderLoginScreenConfig
(String name, String iconUrl, String link, String label, String description, LoginProviderLinkComputer computer) Registers and returns a login screen configuration including a single login provider described by the given parameters.static void
Unregisters the given login screen configuration.
-
Field Details
-
DEFAULT_STARTUP_PAGE_PATH
- Since:
- 8.4
- See Also:
-
-
Method Details
-
getConfig
-
registerSingleProviderLoginScreenConfig
public static LoginScreenConfig registerSingleProviderLoginScreenConfig(String name, String iconUrl, String link, String label, String description, LoginProviderLinkComputer computer) Registers and returns a login screen configuration including a single login provider described by the given parameters.- Since:
- 10.10
-
unregisterLoginScreenConfig
Unregisters the given login screen configuration.- Since:
- 10.10
-
registerLoginProvider
@Deprecated public static void registerLoginProvider(String name, String iconUrl, String link, String label, String description, LoginProviderLinkComputer computer) Deprecated. -
getValueWithDefault
-
getStartupPageURL
Returns the startup page URL according to the path returned bygetStartupPagePath()
.- Since:
- 8.4
-
getStartupPagePath
Returns the path of the startup page depending on theLoginScreenConfig
/LoginStartupPage
contributions to theloginScreen
extension point.- Since:
- 8.4
-
getStartupPagePaths
Returns the paths of the startup pages coming from theLoginScreenConfig
/LoginStartupPage
contributions to theloginScreen
extension point.- Since:
- 8.10
-
getDisplayMobileBanner
public static boolean getDisplayMobileBanner(javax.servlet.http.HttpServletRequest request) Returns whether mobile app banner should be display or not. If thedisplayMobileBanner
request parameter is used, then it overrides theLoginScreenConfig.getDisplayMobileBanner()
configuration. If there is noLoginScreenConfig
, the default value istrue
.- Since:
- 2021.12
-
getDefaultStartupPage
Returns theLoginStartupPage
contribution with the highest priority ornull
if none is contributed.- Since:
- 8.4
-
getPluggableAuthenticationService
-
registerSingleProviderLoginScreenConfig(String, String, String, String, String, LoginProviderLinkComputer)
instead