org.springframework.cloud.servicebroker.model

Class CloudFoundryContext

java.lang.Object

org.springframework.cloud.servicebroker.model.Context

org.springframework.cloud.servicebroker.model.CloudFoundryContext

public final class CloudFoundryContext
extends Context

Cloud Foundry specific contextual information under which the service instance is to be provisioned or updated.

Author:

Scott Frederick, Roy Clarkson

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CloudFoundryContext.CloudFoundryContextBuilder Provides a fluent API for constructing a CloudFoundryContext

Nested classes/interfaces inherited from class org.springframework.cloud.servicebroker.model.Context

Context.ContextBaseBuilder<R extends Context,B extends Context.ContextBaseBuilder<R,B>>

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOUD_FOUNDRY_PLATFORM Cloud Foundry platform key
static String	INSTANCE_NAME_KEY Instance Name key
static String	ORGANIZATION_GUID_KEY Organization GUID key
static String	ORGANIZATION_NAME_KEY Organization Name key
static String	SPACE_GUID_KEY Space GUID key
static String	SPACE_NAME_KEY Space Name key

Fields inherited from class org.springframework.cloud.servicebroker.model.Context

platform, PLATFORM_KEY, properties

Constructor Summary

Constructors

Constructor and Description
CloudFoundryContext(String organizationGuid, String organizationName, String spaceGuid, String spaceName, String instanceName, Map<String,Object> properties) Create a new CloudFoundryContext

Method Summary

Modifier and Type	Method and Description
static CloudFoundryContext.CloudFoundryContextBuilder	builder() Builder for constructing a CloudFoundryContext
String	getInstanceName() Retrieve the instance name from the collection of platform properties
String	getOrganizationGuid() Retrieve the organization GUID from the collection of platform properties
String	getOrganizationName() Retrieve the organization name from the collection of platform properties
Map<String,Object>	getSerializableProperties() Avoid polluting the serialized context with duplicated keys
String	getSpaceGuid() Retrieve the space GUID from the collection of platform properties
String	getSpaceName() Retrieve the space name from the collection of platform properties

Methods inherited from class org.springframework.cloud.servicebroker.model.Context

canEqual, equals, getPlatform, getProperties, getProperty, getStringProperty, hashCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

CLOUD_FOUNDRY_PLATFORM

public static final String CLOUD_FOUNDRY_PLATFORM

Cloud Foundry platform key

See Also:

Constant Field Values

ORGANIZATION_GUID_KEY

public static final String ORGANIZATION_GUID_KEY

Organization GUID key

See Also:

Constant Field Values

ORGANIZATION_NAME_KEY

public static final String ORGANIZATION_NAME_KEY

Organization Name key

See Also:

Constant Field Values

SPACE_GUID_KEY

public static final String SPACE_GUID_KEY

Space GUID key

See Also:

Constant Field Values

SPACE_NAME_KEY

public static final String SPACE_NAME_KEY

Space Name key

See Also:

Constant Field Values

INSTANCE_NAME_KEY

public static final String INSTANCE_NAME_KEY

Instance Name key

See Also:

Constant Field Values

Constructor Detail

CloudFoundryContext

public CloudFoundryContext(String organizationGuid,
                           String organizationName,
                           String spaceGuid,
                           String spaceName,
                           String instanceName,
                           Map<String,Object> properties)

Create a new CloudFoundryContext

Parameters:

organizationGuid - the organization GUID

organizationName - the organization name

spaceGuid - the space GUID

spaceName - the space name

instanceName - the instance name

properties - additional properties

Method Detail

getSerializableProperties

public Map<String,Object> getSerializableProperties()

Avoid polluting the serialized context with duplicated keys

Returns:

a map of properties

getOrganizationGuid

public String getOrganizationGuid()

Retrieve the organization GUID from the collection of platform properties

Returns:

the organization GUID

getOrganizationName

public String getOrganizationName()

Retrieve the organization name from the collection of platform properties

Returns:

the organization name

getSpaceGuid

public String getSpaceGuid()

Retrieve the space GUID from the collection of platform properties

Returns:

the space GUID

getSpaceName

public String getSpaceName()

Retrieve the space name from the collection of platform properties

Returns:

the space name

getInstanceName

public String getInstanceName()

Retrieve the instance name from the collection of platform properties

Returns:

the instance name

builder

public static CloudFoundryContext.CloudFoundryContextBuilder builder()

Builder for constructing a CloudFoundryContext

Returns:

the builder