Package org.nuxeo.ecm.platform.ui.web.auth

Class LoginScreenHelper

java.lang.Object

org.nuxeo.ecm.platform.ui.web.auth.LoginScreenHelper

public class LoginScreenHelper
extends Object

Simple helper class for easy access form the login.jsp page

Since:

5.7

Author:

Tiry

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_STARTUP_PAGE_PATH
protected static Log	log

Method Summary

Modifier and Type	Method	Description
static LoginScreenConfig	getConfig()
protected static LoginStartupPage	getDefaultStartupPage(LoginScreenConfig config)	Returns the LoginStartupPage contribution with the highest priority or null if none is contributed.
static boolean	getDisplayMobileBanner(javax.servlet.http.HttpServletRequest request)	Deprecated. since 2021.63, the mobile banner was removed from the login page
protected static PluggableAuthenticationService	getPluggableAuthenticationService()
static String	getStartupPagePath()	Returns the path of the startup page depending on the LoginScreenConfig/LoginStartupPage contributions to the loginScreen extension point.
static List<String>	getStartupPagePaths()	Returns the paths of the startup pages coming from the LoginScreenConfig/LoginStartupPage contributions to the loginScreen extension point.
static String	getStartupPageURL(javax.servlet.http.HttpServletRequest request)	Returns the startup page URL according to the path returned by getStartupPagePath().
static String	getValueWithDefault(String value, String defaultValue)
static void	registerLoginProvider(String name, String iconUrl, String link, String label, String description, LoginProviderLinkComputer computer)	Deprecated. since 10.10, use registerSingleProviderLoginScreenConfig(String, String, String, String, String, LoginProviderLinkComputer) instead
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	unregisterLoginScreenConfig(LoginScreenConfig config)	Unregisters the given login screen configuration.

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final Log log

DEFAULT_STARTUP_PAGE_PATH

public static final String DEFAULT_STARTUP_PAGE_PATH

Since:

8.4

See Also:

Constant Field Values

Method Detail

getConfig

public static LoginScreenConfig 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

public static void unregisterLoginScreenConfig(LoginScreenConfig config)

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.

since 10.10, use registerSingleProviderLoginScreenConfig(String, String, String, String, String, LoginProviderLinkComputer) instead

getValueWithDefault

public static String getValueWithDefault(String value,
                                         String defaultValue)

getStartupPageURL

public static String getStartupPageURL(javax.servlet.http.HttpServletRequest request)

Returns the startup page URL according to the path returned by getStartupPagePath().

Since:

8.4

getStartupPagePath

public static String getStartupPagePath()

Returns the path of the startup page depending on the LoginScreenConfig/LoginStartupPage contributions to the loginScreen extension point.

Since:

8.4

getStartupPagePaths

public static List<String> getStartupPagePaths()

Returns the paths of the startup pages coming from the LoginScreenConfig/LoginStartupPage contributions to the loginScreen extension point.

Since:

8.10

getDisplayMobileBanner

@Deprecated(since="2021.63")
public static boolean getDisplayMobileBanner(javax.servlet.http.HttpServletRequest request)

Deprecated.

since 2021.63, the mobile banner was removed from the login page

Returns whether mobile app banner should be display or not. If the displayMobileBanner request parameter is used, then it overrides the LoginScreenConfig.getDisplayMobileBanner() configuration. If there is no LoginScreenConfig, the default value is true.

Since:

2021.12

getDefaultStartupPage

protected static LoginStartupPage getDefaultStartupPage(LoginScreenConfig config)

Returns the LoginStartupPage contribution with the highest priority or null if none is contributed.

Since:

8.4

getPluggableAuthenticationService

protected static PluggableAuthenticationService getPluggableAuthenticationService()