org.sonar.api.server.authentication

Class Display

java.lang.Object

org.sonar.api.server.authentication.Display

@Immutable
public final class Display
extends 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 and Description
static class	Display.Builder

Method Summary

Modifier and Type	Method and Description
static Display.Builder	builder()
String	getBackgroundColor() Background color for the provider button displayed in the login form.
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 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 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

builder

public static Display.Builder builder()