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
org.springframework.http.ResponseEntity<CreateServiceInstanceResponse>	createServiceInstance(java.util.Map<java.lang.String,java.lang.String> pathVariables, java.lang.String serviceInstanceId, boolean acceptsIncomplete, java.lang.String apiInfoLocation, java.lang.String originatingIdentityString, @Valid CreateServiceInstanceRequest request)
org.springframework.http.ResponseEntity<DeleteServiceInstanceResponse>	deleteServiceInstance(java.util.Map<java.lang.String,java.lang.String> pathVariables, java.lang.String serviceInstanceId, java.lang.String serviceDefinitionId, java.lang.String planId, boolean acceptsIncomplete, java.lang.String apiInfoLocation, java.lang.String originatingIdentityString)
org.springframework.http.ResponseEntity<GetServiceInstanceResponse>	getServiceInstance(java.util.Map<java.lang.String,java.lang.String> pathVariables, java.lang.String serviceInstanceId, java.lang.String apiInfoLocation, java.lang.String originatingIdentityString)
org.springframework.http.ResponseEntity<GetLastServiceOperationResponse>	getServiceInstanceLastOperation(java.util.Map<java.lang.String,java.lang.String> pathVariables, java.lang.String serviceInstanceId, java.lang.String serviceDefinitionId, java.lang.String planId, java.lang.String operation, java.lang.String apiInfoLocation, java.lang.String originatingIdentityString)
org.springframework.http.ResponseEntity<UpdateServiceInstanceResponse>	updateServiceInstance(java.util.Map<java.lang.String,java.lang.String> pathVariables, java.lang.String serviceInstanceId, boolean acceptsIncomplete, java.lang.String apiInfoLocation, java.lang.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

@Autowired
public ServiceInstanceController(CatalogService catalogService,
                                            ServiceInstanceService serviceInstanceService)

Method Detail

createServiceInstance

@PutMapping(value={"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public org.springframework.http.ResponseEntity<CreateServiceInstanceResponse> createServiceInstance(@PathVariable
                                                                                                                                                                                                                        java.util.Map<java.lang.String,java.lang.String> pathVariables,
                                                                                                                                                                                                                        @PathVariable(value="instanceId")
                                                                                                                                                                                                                        java.lang.String serviceInstanceId,
                                                                                                                                                                                                                        @RequestParam(value="accepts_incomplete",required=false)
                                                                                                                                                                                                                        boolean acceptsIncomplete,
                                                                                                                                                                                                                        @RequestHeader(value="X-Api-Info-Location",required=false)
                                                                                                                                                                                                                        java.lang.String apiInfoLocation,
                                                                                                                                                                                                                        @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
                                                                                                                                                                                                                        java.lang.String originatingIdentityString,
                                                                                                                                                                                                                        @Valid @RequestBody
                                                                                                                                                                                                                        @Valid CreateServiceInstanceRequest request)

getServiceInstance

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

getServiceInstanceLastOperation

@GetMapping(value={"/{platformInstanceId}/v2/service_instances/{instanceId}/last_operation","/v2/service_instances/{instanceId}/last_operation"})
public org.springframework.http.ResponseEntity<GetLastServiceOperationResponse> getServiceInstanceLastOperation(@PathVariable
                                                                                                                                                                                                                                                                  java.util.Map<java.lang.String,java.lang.String> pathVariables,
                                                                                                                                                                                                                                                                  @PathVariable(value="instanceId")
                                                                                                                                                                                                                                                                  java.lang.String serviceInstanceId,
                                                                                                                                                                                                                                                                  @RequestParam(value="service_id",required=false)
                                                                                                                                                                                                                                                                  java.lang.String serviceDefinitionId,
                                                                                                                                                                                                                                                                  @RequestParam(value="plan_id",required=false)
                                                                                                                                                                                                                                                                  java.lang.String planId,
                                                                                                                                                                                                                                                                  @RequestParam(value="operation",required=false)
                                                                                                                                                                                                                                                                  java.lang.String operation,
                                                                                                                                                                                                                                                                  @RequestHeader(value="X-Api-Info-Location",required=false)
                                                                                                                                                                                                                                                                  java.lang.String apiInfoLocation,
                                                                                                                                                                                                                                                                  @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
                                                                                                                                                                                                                                                                  java.lang.String originatingIdentityString)

deleteServiceInstance

@DeleteMapping(value={"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public org.springframework.http.ResponseEntity<DeleteServiceInstanceResponse> deleteServiceInstance(@PathVariable
                                                                                                                                                                                                                           java.util.Map<java.lang.String,java.lang.String> pathVariables,
                                                                                                                                                                                                                           @PathVariable(value="instanceId")
                                                                                                                                                                                                                           java.lang.String serviceInstanceId,
                                                                                                                                                                                                                           @RequestParam(value="service_id")
                                                                                                                                                                                                                           java.lang.String serviceDefinitionId,
                                                                                                                                                                                                                           @RequestParam(value="plan_id")
                                                                                                                                                                                                                           java.lang.String planId,
                                                                                                                                                                                                                           @RequestParam(value="accepts_incomplete",required=false)
                                                                                                                                                                                                                           boolean acceptsIncomplete,
                                                                                                                                                                                                                           @RequestHeader(value="X-Api-Info-Location",required=false)
                                                                                                                                                                                                                           java.lang.String apiInfoLocation,
                                                                                                                                                                                                                           @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
                                                                                                                                                                                                                           java.lang.String originatingIdentityString)

updateServiceInstance

@PatchMapping(value={"/{platformInstanceId}/v2/service_instances/{instanceId}","/v2/service_instances/{instanceId}"})
public org.springframework.http.ResponseEntity<UpdateServiceInstanceResponse> updateServiceInstance(@PathVariable
                                                                                                                                                                                                                          java.util.Map<java.lang.String,java.lang.String> pathVariables,
                                                                                                                                                                                                                          @PathVariable(value="instanceId")
                                                                                                                                                                                                                          java.lang.String serviceInstanceId,
                                                                                                                                                                                                                          @RequestParam(value="accepts_incomplete",required=false)
                                                                                                                                                                                                                          boolean acceptsIncomplete,
                                                                                                                                                                                                                          @RequestHeader(value="X-Api-Info-Location",required=false)
                                                                                                                                                                                                                          java.lang.String apiInfoLocation,
                                                                                                                                                                                                                          @RequestHeader(value="X-Broker-API-Originating-Identity",required=false)
                                                                                                                                                                                                                          java.lang.String originatingIdentityString,
                                                                                                                                                                                                                          @Valid @RequestBody
                                                                                                                                                                                                                          @Valid UpdateServiceInstanceRequest request)