Package 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	Description
static final 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	Description
static final String	CLOUD_FOUNDRY_PLATFORM	Cloud Foundry platform key.
static final String	INSTANCE_NAME_KEY	Instance Name key.
static final String	ORGANIZATION_ANNOTATIONS_KEY	Organization Annotations key.
static final String	ORGANIZATION_GUID_KEY	Organization GUID key.
static final String	ORGANIZATION_NAME_KEY	Organization Name key.
static final String	SPACE_ANNOTATIONS_KEY	Space Annotations key.
static final String	SPACE_GUID_KEY	Space GUID key.
static final 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	Description
CloudFoundryContext(String organizationGuid, String organizationName, String spaceGuid, String spaceName, String instanceName, Map<String,Object> properties)	Create a new CloudFoundryContext.
CloudFoundryContext(String organizationGuid, String organizationName, Map<String,Object> organizationAnnotations, String spaceGuid, String spaceName, Map<String,Object> spaceAnnotations, String instanceName, Map<String,Object> properties)	Create a new CloudFoundryContext.

Method Summary

Modifier and Type	Method	Description
static CloudFoundryContext.CloudFoundryContextBuilder	builder()	Builder for constructing a CloudFoundryContext.
String	getInstanceName()	Retrieve the instance name from the collection of platform properties.
Map<String,Object>	getOrganizationAnnotations()	Retrieve the organization annotations 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.
Map<String,Object>	getSpaceAnnotations()	Retrieve the space annotations from the collection of platform properties.
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, getMapProperty, getPlatform, getProperties, getProperty, getStringProperty, hashCode, setMapProperty, setProperties, setStringProperty, toString

Methods inherited from class java.lang.Object

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

Field Details

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

ORGANIZATION_ANNOTATIONS_KEY

public static final String ORGANIZATION_ANNOTATIONS_KEY

Organization Annotations 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

SPACE_ANNOTATIONS_KEY

public static final String SPACE_ANNOTATIONS_KEY

Space Annotations 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 Details

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

CloudFoundryContext

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

Create a new CloudFoundryContext.

Parameters:

organizationGuid - the organization GUID

organizationName - the organization name

organizationAnnotations - organization annotations

spaceGuid - the space GUID

spaceName - the space name

spaceAnnotations - the space annotations

instanceName - the instance name

properties - additional properties

Method Details

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

getOrganizationAnnotations

public Map<String,Object> getOrganizationAnnotations()

Retrieve the organization annotations from the collection of platform properties.

Returns:

the organization annotations

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

getSpaceAnnotations

public Map<String,Object> getSpaceAnnotations()

Retrieve the space annotations from the collection of platform properties.

Returns:

the space annotations

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