org.springframework.cloud.servicebroker.model

Class AsyncServiceBrokerRequest

java.lang.Object

org.springframework.cloud.servicebroker.model.ServiceBrokerRequest

org.springframework.cloud.servicebroker.model.AsyncServiceBrokerRequest

Direct Known Subclasses:

AsyncParameterizedServiceInstanceRequest, CreateServiceInstanceBindingRequest, DeleteServiceInstanceBindingRequest, DeleteServiceInstanceRequest

public abstract class AsyncServiceBrokerRequest
extends ServiceBrokerRequest

Details of a request that supports asynchronous operations.

Author:

Scott Frederick, Roy Clarkson

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASYNC_REQUEST_PARAMETER Async request parameter key
protected boolean	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, REQUEST_IDENTITY_HEADER, requestIdentity, SERVICE_ID_PARAMETER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsyncServiceBrokerRequest() Create a new AsyncServiceBrokerRequest
protected	AsyncServiceBrokerRequest(boolean asyncAccepted, String platformInstanceId, String apiInfoLocation, Context originatingIdentity, String requestIdentity) Create a new AsyncServiceBrokerRequest

Method Summary

Modifier and Type	Method and Description
boolean	canEqual(Object other) Is another object type compatible with this object
boolean	equals(Object o)
int	hashCode()
boolean	isAsyncAccepted() Get the value indicating whether the platform allows the broker to complete the request asynchronously.
void	setAsyncAccepted(boolean asyncAccepted) This method is intended to be used internally only; use a builder to construct an object of this type and set all field values.
String	toString()

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

getApiInfoLocation, getOriginatingIdentity, getPlatformInstanceId, getRequestIdentity, setApiInfoLocation, setOriginatingIdentity, setPlatformInstanceId, setRequestIdentity

Methods inherited from class java.lang.Object

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

Field Detail

ASYNC_REQUEST_PARAMETER

public static final String ASYNC_REQUEST_PARAMETER

Async request parameter key

See Also:

Constant Field Values

asyncAccepted

protected transient boolean asyncAccepted

Constructor Detail

AsyncServiceBrokerRequest

protected AsyncServiceBrokerRequest()

Create a new AsyncServiceBrokerRequest

AsyncServiceBrokerRequest

protected AsyncServiceBrokerRequest(boolean asyncAccepted,
                                    String platformInstanceId,
                                    String apiInfoLocation,
                                    Context originatingIdentity,
                                    String requestIdentity)

Create a new AsyncServiceBrokerRequest

Parameters:

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

requestIdentity - identity of the request sent from the platform

Method Detail

isAsyncAccepted

public boolean isAsyncAccepted()

Get the value indicating whether the platform allows the broker to complete the request asynchronously.

This value is set from the async_accepted request parameter of the request from the platform.

A false value indicates that clients do not allow asynchronous processing of requests, a true value indicates that clients do allow asynchronous processing.

Returns:

the boolean value

setAsyncAccepted

public void setAsyncAccepted(boolean asyncAccepted)

This method is intended to be used internally only; use a builder to construct an object of this type and set all field values.

Parameters:

asyncAccepted - the value indicating whether the platform allows the broker to complete the request asynchronously

equals

public boolean equals(Object o)

Overrides:

equals in class ServiceBrokerRequest

canEqual

public boolean canEqual(Object other)

Description copied from class: ServiceBrokerRequest

Is another object type compatible with this object

Overrides:

canEqual in class ServiceBrokerRequest

Parameters:

other - the other object

Returns:

true of compatible

hashCode

public int hashCode()

Overrides:

hashCode in class ServiceBrokerRequest

toString

public String toString()

Overrides:

toString in class ServiceBrokerRequest