public class ServiceBrokerRequest extends Object
Modifier and Type | Field and Description |
---|---|
static String |
API_INFO_LOCATION_HEADER
API Info Location header
|
protected String |
apiInfoLocation |
static String |
BINDING_ID_PATH_VARIABLE
Binding ID path variable name
|
static String |
INSTANCE_ID_PATH_VARIABLE
Instance ID path variable name
|
static String |
ORIGINATING_IDENTITY_HEADER
API Originating Identity header
|
protected Context |
originatingIdentity |
static String |
PLAN_ID_PARAMETER
Plan ID parameter name
|
static String |
PLATFORM_INSTANCE_ID_VARIABLE
Platform Instance ID variable name
|
protected String |
platformInstanceId |
static String |
REQUEST_IDENTITY_HEADER
API Request Identity header
|
protected String |
requestIdentity |
static String |
SERVICE_ID_PARAMETER
Service ID parameter name
|
Modifier | Constructor and Description |
---|---|
|
ServiceBrokerRequest()
Construct a new
ServiceBrokerRequest |
protected |
ServiceBrokerRequest(String platformInstanceId,
String apiInfoLocation,
Context originatingIdentity,
String requestIdentity)
Construct a new
ServiceBrokerRequest |
Modifier and Type | Method and Description |
---|---|
boolean |
canEqual(Object other)
Is another object type compatible with this object
|
boolean |
equals(Object o) |
String |
getApiInfoLocation()
Get the location of the API info endpoint of the platform instance.
|
Context |
getOriginatingIdentity()
Get the identity of the user that initiated the request from the platform.
|
String |
getPlatformInstanceId()
Get the ID used to identify the platform instance.
|
String |
getRequestIdentity()
Get the identify of the request that was sent from the platform
|
int |
hashCode() |
void |
setApiInfoLocation(String apiInfoLocation)
This method is intended to be used internally only; use a builder to construct an object of this type
and set all field values.
|
void |
setOriginatingIdentity(Context originatingIdentity)
This method is intended to be used internally only; use a builder to construct an object of this type
and set all field values.
|
void |
setPlatformInstanceId(String platformInstanceId)
This method is intended to be used internally only; use a builder to construct an object of this type
and set all field values.
|
void |
setRequestIdentity(String requestIdentity)
For internal use only; use a builder to construct an object of this type and set all field values.
|
String |
toString() |
public static final String API_INFO_LOCATION_HEADER
public static final String ORIGINATING_IDENTITY_HEADER
public static final String REQUEST_IDENTITY_HEADER
public static final String INSTANCE_ID_PATH_VARIABLE
public static final String BINDING_ID_PATH_VARIABLE
public static final String SERVICE_ID_PARAMETER
public static final String PLAN_ID_PARAMETER
public static final String PLATFORM_INSTANCE_ID_VARIABLE
protected transient String platformInstanceId
protected transient String apiInfoLocation
protected transient Context originatingIdentity
protected transient String requestIdentity
public ServiceBrokerRequest()
ServiceBrokerRequest
protected ServiceBrokerRequest(String platformInstanceId, String apiInfoLocation, Context originatingIdentity, String requestIdentity)
ServiceBrokerRequest
platformInstanceId
- the platform instance IDapiInfoLocation
- location of the API info endpoint of the platform instanceoriginatingIdentity
- identity of the user that initiated the request from the platformrequestIdentity
- identity of the request being sent from the platformpublic String getPlatformInstanceId()
This is useful when the service broker is registered to multiple instances of a platform.
This value is set from any path element that precedes /v2 in the request from the platform. Will be null if the service broker is not registered with an instance ID in the registration URL.
public void setPlatformInstanceId(String platformInstanceId)
platformInstanceId
- the platform instance IDpublic String getApiInfoLocation()
This endpoint can be used to retrieve additional information about the platform making the request on platforms that support the header.
This value is set from the X-Api-Info-Location header in the request from the platform.
public void setApiInfoLocation(String apiInfoLocation)
apiInfoLocation
- location of the API info endpoint of the platform instancepublic Context getOriginatingIdentity()
This value is set from the X-Broker-API-Originating-Identity header in the request from the platform.
public void setOriginatingIdentity(Context originatingIdentity)
originatingIdentity
- identity of the user that initiated the request from the platformpublic String getRequestIdentity()
This value is set from the X-Broker-API-Request-Identity header in the request from the platform
public void setRequestIdentity(String requestIdentity)
requestIdentity
- identify of the request sent from the platformpublic boolean canEqual(Object other)
other
- the other object