Class LoginScreenHelper
- java.lang.Object
-
- org.nuxeo.ecm.platform.ui.web.auth.LoginScreenHelper
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_STARTUP_PAGE_PATH
protected static Log
log
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static LoginScreenConfig
getConfig()
protected static LoginStartupPage
getDefaultStartupPage(LoginScreenConfig config)
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
getPluggableAuthenticationService()
static String
getStartupPagePath()
Returns the path of the startup page depending on theLoginScreenConfig
/LoginStartupPage
contributions to theloginScreen
extension point.static List<String>
getStartupPagePaths()
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
unregisterLoginScreenConfig(LoginScreenConfig config)
Unregisters the given login screen configuration.
-
-
-
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.
-
getStartupPageURL
public static String getStartupPageURL(javax.servlet.http.HttpServletRequest request)
Returns the startup page URL according to the path returned bygetStartupPagePath()
.- Since:
- 8.4
-
getStartupPagePath
public static String getStartupPagePath()
Returns the path of the startup page depending on theLoginScreenConfig
/LoginStartupPage
contributions to theloginScreen
extension point.- Since:
- 8.4
-
getStartupPagePaths
public static List<String> 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
protected static LoginStartupPage getDefaultStartupPage(LoginScreenConfig config)
Returns theLoginStartupPage
contribution with the highest priority ornull
if none is contributed.- Since:
- 8.4
-
getPluggableAuthenticationService
protected static PluggableAuthenticationService getPluggableAuthenticationService()
-
-