Package org.exoplatform.portal.branding

Interface BrandingService

public interface BrandingService

  • Field Details

  • Method Details

    • getBrandingInformation

      Branding getBrandingInformation()

    • getBrandingInformation

      Branding getBrandingInformation(boolean retrieveBinaries)

    • updateBrandingInformation

      void updateBrandingInformation(Branding branding)
      Update the branding information Missing information in the branding object are not updated.
      Parameters:
      branding - The new branding information

    • getCompanyName

      String getCompanyName()

    • getSiteName

      String getSiteName()

    • getCompanyLink

      String getCompanyLink()

    • updateCompanyName

      void updateCompanyName(String companyName)

    • updateCompanyLink

      void updateCompanyLink(String companyLink)

    • updateSiteName

      void updateSiteName(String siteName)

    • getLogoId

      Long getLogoId()

    • getFaviconId

      Long getFaviconId()
      Returns:
      Branding Favicon File technical identifier

    • getLoginBackgroundId

      Long getLoginBackgroundId()
      Returns:
      Login Background File technical identifier

    • getPageBackground

      Background getPageBackground()
      Returns:
      Page Background File details

    • getPageBackgroundId

      Long getPageBackgroundId()
      Returns:
      Page Background File technical identifier

    • getPageBackgroundColor

      String getPageBackgroundColor()
      Returns:
      Page Background Color

    • getPageBackgroundSize

      String getPageBackgroundSize()
      Returns:
      Page Background Size

    • getPageBackgroundPosition

      String getPageBackgroundPosition()
      Returns:
      Page Background Position

    • getPageBackgroundRepeat

      String getPageBackgroundRepeat()
      Returns:
      Page Background repeat directive

    • getLogo

      Logo getLogo()

    • getFavicon

      Favicon getFavicon()
      Returns:
      configured custom Favicon else returns default one

    • getLoginBackground

      Background getLoginBackground()
      Returns:
      configured custom Background else returns default one if exists else null

    • getLoginBackgroundTextColor

      String getLoginBackgroundTextColor()
      Returns:
      Login Text Color displayed on top of the Background

    • getLoginBackgroundAltText

      String getLoginBackgroundAltText()
      Returns:
      Login alt Text displayed on the Background

    • getLogoPath

      String getLogoPath()
      Returns:
      Logo URL to retrieve logo image

    • getFaviconPath

      String getFaviconPath()
      Returns:
      Favicon URL to retrieve favicon image

    • getLoginBackgroundPath

      String getLoginBackgroundPath()
      Returns:
      Background URL to retrieve login background

    • getPageBackgroundPath

      String getPageBackgroundPath()
      Returns:
      Background URL to retrieve page background

    • getPageBackgroundEffect

      String getPageBackgroundEffect()
      Returns:
      the page background Effect

    • getPageBackgroundImageUrl

      String getPageBackgroundImageUrl()
      Returns the URL to retrieve the page background, including the background effect.
      Returns:
      the URL of the page background image

    • getPageWidth

      String getPageWidth()
      Returns:
      Page width

    • getCustomCss

      String getCustomCss()
      Returns:
      Page custom additional css

    • updateLogo

      void updateLogo(Logo logo)
      Update branding logo. If the logo object contains the image data, they are used, otherwise if the uploadId exists it is used to retrieve the uploaded resource. If there is no data, nor uploadId, the logo is deleted.
      Parameters:
      logo - The logo object

    • updateFavicon

      void updateFavicon(Favicon favicon)
      Update branding favicon. If the favicon object contains the image data, they are used, otherwise if the uploadId exists it is used to retrieve the uploaded resource. If there is no data, nor uploadId, the favicon is deleted.
      Parameters:
      favicon - The Favicon object to update

    • updateLoginBackground

      void updateLoginBackground(Background loginBackground)
      Update login background. If the object contains the image data, they are used, otherwise if the uploadId exists it is used to retrieve the uploaded resource. If there is no data, nor uploadId, the login background is deleted.
      Parameters:
      loginBackground - The Background object to update

    • getThemeCSSContent

      String getThemeCSSContent()
      Returns:
      CSS content of colors for theme

    • updateLastUpdatedTime

      void updateLastUpdatedTime(long lastUpdatedTimestamp)
      Updated last updated time of one of Branding properties
      Parameters:
      lastUpdatedTimestamp - Timestamp in milliseconds

    • getLastUpdatedTime

      long getLastUpdatedTime()
      Returns:
      last updated time in milliseconds

    • updateThemeStyle

      void updateThemeStyle(Map<String,String> themeStyle)
      Updates CSS variables that defines the chosen theme and that will be applied and server on UI
      Parameters:
      themeStyle - Map with variable name as key and variable value as map value

    • updateLoginBackgroundTextColor

      void updateLoginBackgroundTextColor(String textColor)
      Updates the login background text color
      Parameters:
      textColor - text color in hex representation like #fff

    • updateLoginBackgroundAltText

      void updateLoginBackgroundAltText(String altText)

    • getThemeStyle

      Map<String,String> getThemeStyle()
      Returns:
      Map with variable name as key and variable value as map value

    • getDefaultThemeStyle

      Map<String,String> getDefaultThemeStyle()
      Returns:
      Map with variable name as key and variable value as map value

    • getLoginTitle

      Map<String,String> getLoginTitle()
      Returns:
      Map of login titles per language

    • getLoginTitle

      String getLoginTitle(Locale locale)
      Parameters:
      locale - user request Locale
      Returns:
      corresponding title to the Locale

    • getLoginSubtitle

      Map<String,String> getLoginSubtitle()
      Returns:
      Map of login subtitles per language

    • getLoginSubtitle

      String getLoginSubtitle(Locale locale)
      Parameters:
      locale - user request Locale
      Returns:
      corresponding subtitle to the Locale

    • getDefaultLanguage

      String getDefaultLanguage()
      Returns:
      default platform language

    • getTopBarBackgroundId

      Long getTopBarBackgroundId()
      Returns:
      Top bar Background File technical identifier

    • getTopBarBackground

      Background getTopBarBackground()
      Returns:
      Top bar Background File technical identifier

    • getTopBarBackgroundPath

      String getTopBarBackgroundPath()
      Returns:
      Background URL to retrieve top bar background

    • getSideBarBackgroundId

      Long getSideBarBackgroundId()
      Returns:
      Sidebar Background File technical identifier

    • getSideBarBackground

      Background getSideBarBackground()
      Returns:
      Sidebar Background File technical identifier

    • getSideBarBackgroundPath

      String getSideBarBackgroundPath()
      Returns:
      Background URL to retrieve sideBar background

    • getDrawerBackgroundId

      Long getDrawerBackgroundId()
      Returns:
      Drawer Background File technical identifier

    • getDrawerBackground

      Background getDrawerBackground()
      Returns:
      Drawer Background File technical identifier

    • getDrawerBackgroundPath

      String getDrawerBackgroundPath()
      Returns:
      Background URL to retrieve drawer background