org.springframework.cloud.servicebroker.model.binding

Class BindResource

java.lang.Object

org.springframework.cloud.servicebroker.model.binding.BindResource

public class BindResource
extends Object

Details of any platform resources that a service binding will be associated with.

Objects of this type are constructed by the framework from the message body passed to the service broker by the platform in a service binding request.

Author:

Scott Frederick

See Also:

Open Service Broker API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BindResource.BindResourceBuilder Provides a fluent API for constructing a BindResource.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BindResource(String appGuid, String route, Map<String,Object> properties) Construct a new BindResource

Method Summary

Modifier and Type	Method and Description
static BindResource.BindResourceBuilder	builder() Create a builder that provides a fluent API for constructing a BindResource.
boolean	equals(Object o)
String	getAppGuid() Get the GUID of an application associated with the binding.
Map<String,Object>	getProperties() Get all properties in the bind resource.
Object	getProperty(String key) Get the value of a property in the bind resource with the given key.
String	getRoute() Get the URL of an application to be intermediated.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BindResource

protected BindResource(String appGuid,
                       String route,
                       Map<String,Object> properties)

Construct a new BindResource

Parameters:

appGuid - the application GUID

route - the application URL

properties - a collection of properties

Method Detail

getProperty

public Object getProperty(String key)

Get the value of a property in the bind resource with the given key.

Parameters:

key - the key of the value to retrieve

Returns:

the value of the property, or null if the key is not present in the bind resource

getProperties

public Map<String,Object> getProperties()

Get all properties in the bind resource.

Returns:

the set of bind resource properties

getAppGuid

public String getAppGuid()

Get the GUID of an application associated with the binding. May be provided for credentials bindings.

Returns:

the application GUID

getRoute

public String getRoute()

Get the URL of an application to be intermediated. May be provided for route services bindings.

Returns:

the application route

builder

public static BindResource.BindResourceBuilder builder()

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

This builder is provided to support testing of ServiceInstanceBindingService implementations.

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