Package com.spotfire.server.security

Class WebAuthProviderDescription

java.lang.Object

com.spotfire.server.security.WebAuthProviderDescription

public final class WebAuthProviderDescription
extends Object

Describes a web authentication provider so that it may be displayed on the login page.

Since:

7.8

Constructor Summary

Constructors

Constructor	Description
WebAuthProviderDescription(String label, String providerName, String color)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
String	getColor()	Returns the CSS color to use as background color of the button on the login page, or null if the default color should be used.
String	getLabel()	Returns the label to be shown on the login page.
String	getProviderName()	Returns the name of the provider.

Methods inherited from class java.lang.Object

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

Constructor Details

WebAuthProviderDescription

public WebAuthProviderDescription(String label,
 String providerName,
 String color)

Creates a new instance.

Parameters:

label - the label to be displayed on the login page, must not be null

providerName - the name of the provider, will be passed to the authenticator when retrieving the authentication endpoint URL, must not be null

color - the background color of the button on the login page, may be null in which case a default color will be used

Since:

7.8

See Also:

• CustomWebAuthenticator.getAuthenticationEndpoint(java.util.Map, String, String)

Method Details

getLabel

public String getLabel()

Returns the label to be shown on the login page.

Returns:

the label to be shown on the login page

Since:

7.8

getProviderName

public String getProviderName()

Returns the name of the provider. This value will be passed to the authenticator when retrieving the authentication endpoint URL, it will not be shown to end-users.

Returns:

the name of the provider

Since:

7.8

See Also:

• CustomWebAuthenticator.getAuthenticationEndpoint(java.util.Map, String, String)

getColor

public String getColor()

Returns the CSS color to use as background color of the button on the login page, or null if the default color should be used.

Returns:

the CSS color to use as background color of the button on the login page, or null if the default color should be used

Since:

7.8