Package org.springframework.cloud.servicebroker.model.catalog

Class DashboardClient

java.lang.Object

org.springframework.cloud.servicebroker.model.catalog.DashboardClient

public class DashboardClient
extends Object

The dashboard URI for a ServiceDefinition.

Author:

Scott Frederick, Roy Clarkson

See Also:

• Open Service Broker API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DashboardClient.DashboardClientBuilder	Provides a fluent API for constructing a DashboardClient.

Constructor Summary

Constructors

Constructor	Description
DashboardClient()	Construct a new DashboardClient.
DashboardClient(String id, String secret, String redirectUri)	Construct a new DashboardClient.

Method Summary

Modifier and Type	Method	Description
static DashboardClient.DashboardClientBuilder	builder()	Create a builder that provides a fluent API for constructing a DashboardClient.
final boolean	equals(Object o)
String	getId()	The client ID of the dashboard OAuth2 client that the service intends to use.
String	getRedirectUri()	A domain for the service dashboard that will be whitelisted by the UAA to enable dashboard SSO.
String	getSecret()	The client secret for the dashboard OAuth2 client.
final int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DashboardClient

public DashboardClient()

Construct a new DashboardClient.

DashboardClient

public DashboardClient(String id,
 String secret,
 String redirectUri)

Construct a new DashboardClient.

Parameters:

id - the client ID

secret - the client secret

redirectUri - the dashboard URI

Method Details

getId

public String getId()

The client ID of the dashboard OAuth2 client that the service intends to use. The name must be unique within the platform. If the name is already in use, the platform will return an error to the operator when the service is registered.

Returns:

the client ID

getSecret

public String getSecret()

The client secret for the dashboard OAuth2 client.

Returns:

the client secret

getRedirectUri

public String getRedirectUri()

A domain for the service dashboard that will be whitelisted by the UAA to enable dashboard SSO.

Returns:

the dashboard URI

builder

public static DashboardClient.DashboardClientBuilder builder()

Create a builder that provides a fluent API for constructing a DashboardClient.

Returns:

the builder

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object