Package org.sonar.api.server.authentication

Class Display

  • @Immutable
public final class Display
extends java.lang.Object
    Display information provided by the Identity Provider to be displayed into the login form.
    Since:
    5.4

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Display.Builder  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Display.Builder builder()  
      java.lang.String getBackgroundColor()
      Background color for the provider button displayed in the login form.
      java.lang.String getHelpMessage()
      Optional help message to be displayed near the provider button.
      java.lang.String getIconPath()
      URL path to the provider icon, as deployed at runtime, for example "/static/authgithub/github.svg" (in this case "authgithub" is the plugin key.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getIconPath

        public java.lang.String getIconPath()
        URL path to the provider icon, as deployed at runtime, for example "/static/authgithub/github.svg" (in this case "authgithub" is the plugin key. Source file is "src/main/resources/static/github.svg"). It can also be an external URL, for example "http://www.mydomain/myincon.png". Must not be blank.
        The recommended format is SVG with a size of 24x24 pixels. Other supported format is PNG, with a size of 40x40 pixels.

      • getBackgroundColor

        public java.lang.String getBackgroundColor()
        Background color for the provider button displayed in the login form. It's a Hexadecimal value, for instance #205081.
        If not provided, the default value is #236a97

      • getHelpMessage

        @CheckForNull
public java.lang.String getHelpMessage()
        Optional help message to be displayed near the provider button.