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:

[email protected], 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 and Description
ServiceInstanceController(CatalogService catalogService, ServiceInstanceService serviceInstanceService)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<ResponseEntity<CreateServiceInstanceResponse>>	createServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, @Valid CreateServiceInstanceRequest request)
reactor.core.publisher.Mono<ResponseEntity<DeleteServiceInstanceResponse>>	deleteServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, String serviceDefinitionId, String planId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString)
reactor.core.publisher.Mono<ResponseEntity<GetServiceInstanceResponse>>	getServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, String apiInfoLocation, String originatingIdentityString)
reactor.core.publisher.Mono<ResponseEntity<GetLastServiceOperationResponse>>	getServiceInstanceLastOperation(Map<String,String> pathVariables, String serviceInstanceId, String serviceDefinitionId, String planId, String operation, String apiInfoLocation, String originatingIdentityString)
reactor.core.publisher.Mono<ResponseEntity<UpdateServiceInstanceResponse>>	updateServiceInstance(Map<String,String> pathVariables, String serviceInstanceId, boolean acceptsIncomplete, String apiInfoLocation, String originatingIdentityString, @Valid UpdateServiceInstanceRequest request)

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

getAsyncResponseCode, getRequiredServiceDefinition, getServiceDefinition, getServiceDefinitionPlan, parseOriginatingIdentity, setCommonRequestFields, setCommonRequestFields

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceInstanceController

public ServiceInstanceController(CatalogService catalogService,
                                 ServiceInstanceService serviceInstanceService)

Method Detail

createServiceInstance

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

getServiceInstance

@GetMapping(value={"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public reactor.core.publisher.Mono<ResponseEntity<GetServiceInstanceResponse>> getServiceInstance(@PathVariable
                                                                                                                                                                                                                      Map<String,String> pathVariables,
                                                                                                                                                                                                                      @PathVariable(value="instanceId")
                                                                                                                                                                                                                      String serviceInstanceId,
                                                                                                                                                                                                                      @RequestHeader(value="X-Api-Info-Location",required=false)
                                                                                                                                                                                                                      String apiInfoLocation,
                                                                                                                                                                                                                      @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
                                                                                                                                                                                                                      String originatingIdentityString)

getServiceInstanceLastOperation

@GetMapping(value={"/{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(value="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)

deleteServiceInstance

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

updateServiceInstance

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