org.springframework.cloud.servicebroker.model.instance

Class AsyncParameterizedServiceInstanceRequest

java.lang.Object

org.springframework.cloud.servicebroker.model.ServiceBrokerRequest

org.springframework.cloud.servicebroker.model.AsyncServiceBrokerRequest

org.springframework.cloud.servicebroker.model.instance.AsyncParameterizedServiceInstanceRequest

Direct Known Subclasses:

CreateServiceInstanceRequest, UpdateServiceInstanceRequest

public abstract class AsyncParameterizedServiceInstanceRequest
extends AsyncServiceBrokerRequest

Details of a request that supports arbitrary parameters and asynchronous behavior.

Author:

Scott Frederick

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	parameters

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

ASYNC_REQUEST_PARAMETER, asyncAccepted

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

API_INFO_LOCATION_HEADER, apiInfoLocation, BINDING_ID_PATH_VARIABLE, INSTANCE_ID_PATH_VARIABLE, ORIGINATING_IDENTITY_HEADER, originatingIdentity, PLAN_ID_PARAMETER, PLATFORM_INSTANCE_ID_VARIABLE, platformInstanceId, SERVICE_ID_PARAMETER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncParameterizedServiceInstanceRequest() Construct a new AsyncParameterizedServiceInstanceRequest
protected	AsyncParameterizedServiceInstanceRequest(Map<String,Object> parameters, Context context, boolean asyncAccepted, String platformInstanceId, String apiInfoLocation, Context originatingIdentity) Construct a new AsyncParameterizedServiceInstanceRequest

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(Object other) Is another object type compatible with this object
boolean	equals(Object o)
Context	getContext() Get the platform-specific contextual information for the service instance.
Map<String,Object>	getParameters() Get any parameters passed by the user, with the user-supplied JSON structure converted to a Map.
<T> T	getParameters(Class<T> cls) Get any parameters passed by the user, with the user-supplied JSON structure mapped to fields of the specified object type.
int	hashCode()
String	toString()

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

isAsyncAccepted, setAsyncAccepted

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

getApiInfoLocation, getOriginatingIdentity, getPlatformInstanceId, setApiInfoLocation, setOriginatingIdentity, setPlatformInstanceId

Methods inherited from class java.lang.Object

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

Field Detail

parameters

protected final Map<String,Object> parameters

Constructor Detail

AsyncParameterizedServiceInstanceRequest

protected AsyncParameterizedServiceInstanceRequest()

Construct a new AsyncParameterizedServiceInstanceRequest

AsyncParameterizedServiceInstanceRequest

protected AsyncParameterizedServiceInstanceRequest(Map<String,Object> parameters,
                                                   Context context,
                                                   boolean asyncAccepted,
                                                   String platformInstanceId,
                                                   String apiInfoLocation,
                                                   Context originatingIdentity)

Construct a new AsyncParameterizedServiceInstanceRequest

Parameters:

parameters - the parameters

context - the context

asyncAccepted - does the platform accept asynchronous requests

platformInstanceId - the platform instance ID

apiInfoLocation - location of the API info endpoint of the platform instance

originatingIdentity - identity of the user that initiated the request from the platform

Method Detail

getParameters

public Map<String,Object> getParameters()

Get any parameters passed by the user, with the user-supplied JSON structure converted to a Map.

This value is set from the parameters field in the body of the request from the platform.

The platform will pass the user-supplied JSON structure to the service broker as-is. The service broker is responsible for validating the contents of the parameters for correctness or applicability.

Returns:

the populated Map

getParameters

public <T> T getParameters(Class<T> cls)

Get any parameters passed by the user, with the user-supplied JSON structure mapped to fields of the specified object type.

This value is set from the parameters field in the body of the request from the platform.

An object of the specified type will be instantiated, and value from the parameters JSON will be mapped to the object using Java Bean mapping rules.

The platform will pass the user-supplied JSON structure to the service broker as-is. The service broker is responsible for validating the contents of the parameters for correctness or applicability.

Type Parameters:

T - the type of the object to instantiate and populate

Parameters:

cls - the Class representing the type of object to map the parameter key/value pairs to

Returns:

the instantiated and populated object

getContext

public Context getContext()

Get the platform-specific contextual information for the service instance.

This value is set from the context field in the body of the request from the platform.

Returns:

the contextual information

equals

public boolean equals(Object o)

Overrides:

equals in class AsyncServiceBrokerRequest

canEqual

public boolean canEqual(Object other)

Description copied from class: ServiceBrokerRequest

Is another object type compatible with this object

Overrides:

canEqual in class AsyncServiceBrokerRequest

Parameters:

other - the other object

Returns:

true of compatible

hashCode

public int hashCode()

Overrides:

hashCode in class AsyncServiceBrokerRequest

toString

public String toString()

Overrides:

toString in class AsyncServiceBrokerRequest