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

Class LoginScreenConfig

java.lang.Object
org.nuxeo.ecm.platform.ui.web.auth.service.LoginScreenConfig
public class LoginScreenConfig extends Object
XMap object to manage configuration of the login screen (login.jsp)
Since:
5.7
Author:
Tiry

  • Field Details

    • NUXEO_NEWS_URL

      public static final String NUXEO_NEWS_URL
      See Also:

    • startupPages

      protected Map<String,LoginStartupPage> startupPages
      Since:
      8.4

    • providers

      protected List<LoginProviderLink> providers

    • videos

      protected List<LoginVideo> videos
      Since:
      7.10

    • muted

      protected Boolean muted
      Since:
      7.10

    • loop

      protected Boolean loop
      Since:
      7.10

    • backgroundImage

      protected String backgroundImage
      Since:
      7.10

    • removeNews

      protected Boolean removeNews

    • displayMobileBanner

      @Deprecated(since="2023.22") protected Boolean displayMobileBanner
      Deprecated.
      since 2023.22, the mobile banner was removed from the login page
      Since:
      2021.12

    • headerStyle

      protected String headerStyle

    • footerStyle

      protected String footerStyle

    • newsIframeUrl

      protected String newsIframeUrl

    • newsIframeFullUrl

      protected String newsIframeFullUrl

    • bodyBackgroundStyle

      protected String bodyBackgroundStyle

    • loginBoxBackgroundStyle

      protected String loginBoxBackgroundStyle

    • loginBoxWidth

      protected String loginBoxWidth

    • logoUrl

      protected String logoUrl

    • logoAlt

      protected String logoAlt

    • logoWidth

      protected String logoWidth

    • logoHeight

      protected String logoHeight

    • fieldAutocomplete

      protected Boolean fieldAutocomplete
      Since:
      7.10

    • disableBackgroundSizeCover

      protected Boolean disableBackgroundSizeCover
      Boolean to disable background-cover CSS behavior on login page background, as it may not be compliant with all browsers (see NXP-12972/NXP-12978).
      Since:
      5.8

    • loginButtonBackgroundColor

      protected String loginButtonBackgroundColor
      Since:
      7.10

    • defaultLocale

      protected String defaultLocale
      Since:
      8.4

  • Constructor Details

    • LoginScreenConfig

      public LoginScreenConfig()

    • LoginScreenConfig

      public LoginScreenConfig(LoginProviderLink provider)
      Instantiates a login screen configuration with the given login provider.
      Since:
      10.10

  • Method Details

    • getProviders

      public List<LoginProviderLink> getProviders()

    • setProviders

      public void setProviders(List<LoginProviderLink> providers)

    • getProvider

      public LoginProviderLink getProvider(String name)

    • registerLoginProvider

      @Deprecated public void registerLoginProvider(String name, String iconUrl, String link, String label, String description, LoginProviderLinkComputer computer)
      Deprecated.
      since 10.10, use LoginScreenConfig(LoginProviderLink) instead

    • getStartupPages

      public Map<String,LoginStartupPage> getStartupPages()
      Since:
      8.4

    • getHeaderStyle

      public String getHeaderStyle()

    • getFooterStyle

      public String getFooterStyle()

    • getBodyBackgroundStyle

      public String getBodyBackgroundStyle()

    • getLoginBoxBackgroundStyle

      public String getLoginBoxBackgroundStyle()

    • getLoginBoxWidth

      public String getLoginBoxWidth()

    • getLogoUrl

      public String getLogoUrl()

    • getLogoAlt

      public String getLogoAlt()

    • getLogoWidth

      public String getLogoWidth()

    • getLogoHeight

      public String getLogoHeight()

    • getVideos

      public List<LoginVideo> getVideos()

    • getVideoMuted

      public Boolean getVideoMuted()

    • getVideoLoop

      public Boolean getVideoLoop()

    • hasVideos

      public boolean hasVideos()

    • getDisplayNews

      public boolean getDisplayNews()

    • getDisplayMobileBanner

      @Deprecated(since="2023.22") public boolean getDisplayMobileBanner()
      Deprecated.
      since 2023.22, the mobile banner was removed from the login page

    • getFieldAutocomplete

      public Boolean getFieldAutocomplete()

    • setHeaderStyle

      public void setHeaderStyle(String headerStyle)

    • setFooterStyle

      public void setFooterStyle(String footerStyle)

    • setBodyBackgroundStyle

      public void setBodyBackgroundStyle(String bodyBackgroundStyle)

    • setBackgroundImage

      public void setBackgroundImage(String backgroundImage)

    • getBackgroundImage

      public String getBackgroundImage()

    • getLoginButtonBackgroundColor

      public String getLoginButtonBackgroundColor()

    • setLoginBoxBackgroundStyle

      public void setLoginBoxBackgroundStyle(String loginBoxBackgroundStyle)

    • setLogoUrl

      public void setLogoUrl(String logoUrl)

    • setNewsIframeUrl

      public void setNewsIframeUrl(String newsIframeUrl)
      Since:
      7.10

    • internalGetNewsIframeUrl

      protected String internalGetNewsIframeUrl()

    • getNewsIframeUrl

      public String getNewsIframeUrl()

    • getDisableBackgroundSizeCover

      public Boolean getDisableBackgroundSizeCover()
      Since:
      5.8
      See Also:

    • getDefaultLocale

      public String getDefaultLocale()
      Since:
      8.4

    • isAppendSupportedLocales

      public Boolean isAppendSupportedLocales()
      Since:
      8.4

    • getSupportedLocales

      public List<String> getSupportedLocales()
      Since:
      8.4

    • merge

      protected void merge(LoginScreenConfig newConfig)

    • clone

      public LoginScreenConfig clone()
      Overrides:
      clone in class Object
      Since:
      7.10