Package org.springframework.cloud.servicebroker.controller

Class ServiceInstanceController

java.lang.Object

org.springframework.cloud.servicebroker.controller.BaseController

org.springframework.cloud.servicebroker.controller.ServiceInstanceController

@ServiceBrokerRestController
public class ServiceInstanceController
extends BaseController

Provide endpoints for the service instances 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
ServiceInstanceController(CatalogService catalogService, ServiceInstanceService serviceInstanceService)	Construct a new ServiceInstanceController.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<ResponseEntity<CreateServiceInstanceResponse>>	createServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, String requestIdentity, @Valid CreateServiceInstanceRequest request)	REST controller for creating a service instance.
reactor.core.publisher.Mono<ResponseEntity<DeleteServiceInstanceResponse>>	deleteServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, String serviceDefinitionId, String planId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, String requestIdentity)	REST controller for deleting a service instance.
reactor.core.publisher.Mono<ResponseEntity<GetServiceInstanceResponse>>	getServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, String serviceDefinitionId, String planId, String apiInfoLocation, String originatingIdentityString, String requestIdentity)	REST controller for getting a service instance.
reactor.core.publisher.Mono<ResponseEntity<GetLastServiceOperationResponse>>	getServiceInstanceLastOperation(Map<String,String> pathVariables, String serviceInstanceId, String serviceDefinitionId, String planId, String operation, String apiInfoLocation, String originatingIdentityString, String requestIdentity)	REST controller for getting the last operation of a service instance.
reactor.core.publisher.Mono<ResponseEntity<UpdateServiceInstanceResponse>>	updateServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, String requestIdentity, @Valid UpdateServiceInstanceRequest request)	REST controller for updating a service instance.

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

ServiceInstanceController

public ServiceInstanceController(CatalogService catalogService,
 ServiceInstanceService serviceInstanceService)

Construct a new ServiceInstanceController.

Parameters:

catalogService - the catalog service

serviceInstanceService - the service instance service

Method Details

createServiceInstance

@PutMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public reactor.core.publisher.Mono<ResponseEntity<CreateServiceInstanceResponse>> createServiceInstance(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @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 CreateServiceInstanceRequest request)

REST controller for creating a service instance.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance 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

getServiceInstance

@GetMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public reactor.core.publisher.Mono<ResponseEntity<GetServiceInstanceResponse>> getServiceInstance(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @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.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance 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

getServiceInstanceLastOperation

@GetMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}/last_operation","/v2/service_instances/{instanceId}/last_operation"})
public reactor.core.publisher.Mono<ResponseEntity<GetLastServiceOperationResponse>> getServiceInstanceLastOperation(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @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.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance 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

deleteServiceInstance

@DeleteMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public reactor.core.publisher.Mono<ResponseEntity<DeleteServiceInstanceResponse>> deleteServiceInstance(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @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.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance 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

updateServiceInstance

@PatchMapping({"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public reactor.core.publisher.Mono<ResponseEntity<UpdateServiceInstanceResponse>> updateServiceInstance(@PathVariable
 Map<String,String> pathVariables,
 @PathVariable("instanceId")
 String serviceInstanceId,
 @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 UpdateServiceInstanceRequest request)

REST controller for updating a service instance.

Parameters:

pathVariables - the path variables

serviceInstanceId - the service instance 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