Package org.springframework.cloud.servicebroker.controller

Class ServiceInstanceBindingController

java.lang.Object

org.springframework.cloud.servicebroker.controller.BaseController

org.springframework.cloud.servicebroker.controller.ServiceInstanceBindingController

@ServiceBrokerRestController
public class ServiceInstanceBindingController
extends BaseController

Provide endpoints for the service bindings API.

Author:

S Greenberg, Scott Frederick, Roy Clarkson

See Also:

• Open Service Broker API specification

Field Summary

Fields inherited from class org.springframework.cloud.servicebroker.controller.BaseController

catalogService

Constructor Summary

Constructors

Constructor	Description
ServiceInstanceBindingController(CatalogService catalogService, ServiceInstanceBindingService serviceInstanceBindingService)	Construct a new ServiceInstanceBindingController.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<ResponseEntity<CreateServiceInstanceBindingResponse>>	createServiceInstanceBinding(Map<String,String> pathVariables, String serviceInstanceId, String bindingId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, String requestIdentity, @Valid CreateServiceInstanceBindingRequest request)	REST controller for creating a service instance binding.
reactor.core.publisher.Mono<ResponseEntity<DeleteServiceInstanceBindingResponse>>	deleteServiceInstanceBinding(Map<String,String> pathVariables, String serviceInstanceId, String bindingId, String serviceDefinitionId, String planId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, String requestIdentity)	REST controller for deleting a service instance binding.
reactor.core.publisher.Mono<ResponseEntity<GetServiceInstanceBindingResponse>>	getServiceInstanceBinding(Map<String,String> pathVariables, String serviceInstanceId, String bindingId, String serviceDefinitionId, String planId, String apiInfoLocation, String originatingIdentityString, String requestIdentity)	REST controller for getting a service instance binding.
reactor.core.publisher.Mono<ResponseEntity<GetLastServiceBindingOperationResponse>>	getServiceInstanceBindingLastOperation(Map<String,String> pathVariables, String serviceInstanceId, String bindingId, String serviceDefinitionId, String planId, String operation, String apiInfoLocation, String originatingIdentityString, String requestIdentity)	REST Controller for getting the last operation of a service instance binding.

Methods inherited from class org.springframework.cloud.servicebroker.controller.BaseController

configureCommonRequestFields, configureCommonRequestFields, getAsyncResponseCode, getRequiredServiceDefinition, getRequiredServiceDefinitionPlan, getServiceDefinition, getServiceDefinitionPlan, parseOriginatingIdentity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ServiceInstanceBindingController

public ServiceInstanceBindingController(CatalogService catalogService,
 ServiceInstanceBindingService serviceInstanceBindingService)

Construct a new ServiceInstanceBindingController.

Parameters:

catalogService - the catalog service.

serviceInstanceBindingService - the service instance binding service

Method Details

createServiceInstanceBinding

@PutMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}/service_bindings/{bindingId}","/v2/service_instances/{instanceId}/service_bindings/{bindingId}"})
public reactor.core.publisher.Mono<ResponseEntity<CreateServiceInstanceBindingResponse>> createServiceInstanceBinding(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @PathVariable("bindingId")
 String bindingId,
 @RequestParam(value="accepts_incomplete",required=false)
 boolean acceptsIncomplete,
 @RequestHeader(value="X-Api-Info-Location",required=false)
 String apiInfoLocation,
 @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
 String originatingIdentityString,
 @RequestHeader(value="X-Broker-API-Request-Identity",required=false)
 String requestIdentity,
 @Valid @RequestBody
 @Valid CreateServiceInstanceBindingRequest request)

REST controller for creating a service instance binding.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance ID

bindingId - the service binding ID

acceptsIncomplete - indicates an asynchronous request

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

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

requestIdentity - identity of the request sent from the platform

request - the request body

Returns:

the response

getServiceInstanceBinding

@GetMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}/service_bindings/{bindingId}","/v2/service_instances/{instanceId}/service_bindings/{bindingId}"})
public reactor.core.publisher.Mono<ResponseEntity<GetServiceInstanceBindingResponse>> getServiceInstanceBinding(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @PathVariable("bindingId")
 String bindingId,
 @RequestParam(value="service_id",required=false)
 String serviceDefinitionId,
 @RequestParam(value="plan_id",required=false)
 String planId,
 @RequestHeader(value="X-Api-Info-Location",required=false)
 String apiInfoLocation,
 @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
 String originatingIdentityString,
 @RequestHeader(value="X-Broker-API-Request-Identity",required=false)
 String requestIdentity)

REST controller for getting a service instance binding.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance ID

bindingId - the service binding ID

serviceDefinitionId - the service definition ID

planId - the plan ID

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

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

requestIdentity - identity of the request sent from the platform

Returns:

the response

getServiceInstanceBindingLastOperation

@GetMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}/service_bindings/{bindingId}/last_operation","/v2/service_instances/{instanceId}/service_bindings/{bindingId}/last_operation"})
public reactor.core.publisher.Mono<ResponseEntity<GetLastServiceBindingOperationResponse>> getServiceInstanceBindingLastOperation(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @PathVariable("bindingId")
 String bindingId,
 @RequestParam(value="service_id",required=false)
 String serviceDefinitionId,
 @RequestParam(value="plan_id",required=false)
 String planId,
 @RequestParam(value="operation",required=false)
 String operation,
 @RequestHeader(value="X-Api-Info-Location",required=false)
 String apiInfoLocation,
 @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
 String originatingIdentityString,
 @RequestHeader(value="X-Broker-API-Request-Identity",required=false)
 String requestIdentity)

REST Controller for getting the last operation of a service instance binding.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance ID

bindingId - the service binding ID

serviceDefinitionId - the service definition ID

planId - the plan ID

operation - description of the operation being performed

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

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

requestIdentity - identity of the request sent from the platform

Returns:

the response

deleteServiceInstanceBinding

@DeleteMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}/service_bindings/{bindingId}","/v2/service_instances/{instanceId}/service_bindings/{bindingId}"})
public reactor.core.publisher.Mono<ResponseEntity<DeleteServiceInstanceBindingResponse>> deleteServiceInstanceBinding(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @PathVariable("bindingId")
 String bindingId,
 @RequestParam("service_id")
 String serviceDefinitionId,
 @RequestParam("plan_id")
 String planId,
 @RequestParam(value="accepts_incomplete",required=false)
 boolean acceptsIncomplete,
 @RequestHeader(value="X-Api-Info-Location",required=false)
 String apiInfoLocation,
 @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
 String originatingIdentityString,
 @RequestHeader(value="X-Broker-API-Request-Identity",required=false)
 String requestIdentity)

REST controller for deleting a service instance binding.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance ID

bindingId - the service binding ID

serviceDefinitionId - the service definition ID

planId - the plan ID

acceptsIncomplete - indicates an asynchronous request

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

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

requestIdentity - identity of the request sent from the platform

Returns:

the response