org.springframework.cloud.servicebroker.service

Interface ServiceInstanceService

public interface ServiceInstanceService

This interface is implemented by service brokers to process requests related to provisioning, updating, and deprovisioning service instances.

Author:

[email protected], Scott Frederick

Method Summary

Modifier and Type	Method and Description
CreateServiceInstanceResponse	createServiceInstance(CreateServiceInstanceRequest request) Create (provision) a new service instance.
DeleteServiceInstanceResponse	deleteServiceInstance(DeleteServiceInstanceRequest request) Delete (deprovision) a service instance.
default GetLastServiceOperationResponse	getLastOperation(GetLastServiceOperationRequest request) Get the status of the last requested operation for a service instance.
default GetServiceInstanceResponse	getServiceInstance(GetServiceInstanceRequest request) Get the details of a service instance.
default UpdateServiceInstanceResponse	updateServiceInstance(UpdateServiceInstanceRequest request) Update a service instance.

Method Detail

createServiceInstance

CreateServiceInstanceResponse createServiceInstance(CreateServiceInstanceRequest request)

Create (provision) a new service instance.

Parameters:

request - containing the details of the request

Returns:

a CreateServiceInstanceResponse on successful processing of the request

Throws:

ServiceInstanceExistsException - if a service instance with the given ID is already known to the broker

ServiceBrokerAsyncRequiredException - if the broker requires asynchronous processing of the request

ServiceBrokerInvalidParametersException - if any parameters passed in the request are invalid

getServiceInstance

default GetServiceInstanceResponse getServiceInstance(GetServiceInstanceRequest request)

Get the details of a service instance.

Parameters:

request - containing the details of the request

Returns:

a GetServiceInstanceResponse on successful processing of the request

Throws:

ServiceInstanceDoesNotExistException - if a service instance with the given ID is not known to the broker

ServiceBrokerOperationInProgressException - if a an operation is in progress for the service instance

getLastOperation

default GetLastServiceOperationResponse getLastOperation(GetLastServiceOperationRequest request)

Get the status of the last requested operation for a service instance.

Parameters:

request - containing the details of the request

Returns:

a GetLastServiceOperationResponse on successful processing of the request

Throws:

ServiceInstanceDoesNotExistException - if a service instance with the given ID is not known to the broker

deleteServiceInstance

DeleteServiceInstanceResponse deleteServiceInstance(DeleteServiceInstanceRequest request)

Delete (deprovision) a service instance.

Parameters:

request - containing the details of the request

Returns:

a DeleteServiceInstanceResponse on successful processing of the request

Throws:

ServiceInstanceDoesNotExistException - if a service instance with the given ID is not known to the broker

ServiceBrokerAsyncRequiredException - if the broker requires asynchronous processing of the request

updateServiceInstance

default UpdateServiceInstanceResponse updateServiceInstance(UpdateServiceInstanceRequest request)

Update a service instance.

Parameters:

request - containing the details of the request

Returns:

an UpdateServiceInstanceResponse on successful processing of the request

Throws:

ServiceInstanceUpdateNotSupportedException - if particular change is not supported or if the request can not currently be fulfilled due to the state of the instance

ServiceInstanceDoesNotExistException - if a service instance with the given ID is not known to the broker

ServiceBrokerAsyncRequiredException - if the broker requires asynchronous processing of the request

ServiceBrokerInvalidParametersException - if any parameters passed in the request are invalid