Package org.springframework.cloud.servicebroker.service

Interface ServiceInstanceBindingService

All Known Implementing Classes:

NonBindableServiceInstanceBindingService, ServiceInstanceBindingEventService

public interface ServiceInstanceBindingService

This interface is implemented by service brokers to process requests to create and delete service instance bindings.

Author:

S Greenberg, Scott Frederick, Roy Clarkson

Method Summary

Modifier and Type	Method	Description
default reactor.core.publisher.Mono<CreateServiceInstanceBindingResponse>	createServiceInstanceBinding(CreateServiceInstanceBindingRequest request)	Create a new binding to a service instance.
default reactor.core.publisher.Mono<DeleteServiceInstanceBindingResponse>	deleteServiceInstanceBinding(DeleteServiceInstanceBindingRequest request)	Delete a service instance binding.
default reactor.core.publisher.Mono<GetLastServiceBindingOperationResponse>	getLastOperation(GetLastServiceBindingOperationRequest request)	Get the status of the last requested operation for a service instance.
default reactor.core.publisher.Mono<GetServiceInstanceBindingResponse>	getServiceInstanceBinding(GetServiceInstanceBindingRequest request)	Get the details of a binding to a service instance.

Method Details

createServiceInstanceBinding

default reactor.core.publisher.Mono<CreateServiceInstanceBindingResponse> createServiceInstanceBinding(CreateServiceInstanceBindingRequest request)

Create a new binding to a service instance. In the case of a request to create a new service instance binding with an existing binding id, the implementor should throw an ServiceInstanceBindingExistsException, which will return a HTTP 409. If the request includes identical parameters as an existing binding, then the implementor should set CreateServiceInstanceBindingResponse.isBindingExisted(), which will result in an HTTP 200 with the populated response body.

Parameters:

request - containing the details of the request

Returns:

a CreateServiceInstanceBindingResponse on successful processing of the request

Throws:

ServiceInstanceBindingExistsException - if a binding with the given ID is already known to the broker

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

ServiceBrokerBindingRequiresAppException - if the broker only supports application binding but an app GUID is not provided in the request

ServiceBrokerAsyncRequiredException - if the broker requires asynchronous processing of the request

ServiceBrokerCreateOperationInProgressException - if an operation is in progress for the service binding

See Also:

• https://github.com/openservicebrokerapi/servicebroker/blob/v2.16/spec.md#response-6

getServiceInstanceBinding

default reactor.core.publisher.Mono<GetServiceInstanceBindingResponse> getServiceInstanceBinding(GetServiceInstanceBindingRequest request)

Get the details of a binding to a service instance.

Parameters:

request - containing the details of the request

Returns:

a GetServiceInstanceBindingResponse on successful processing of the request

Throws:

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

ServiceInstanceBindingDoesNotExistException - if a binding with the given ID is not known to the broker

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

getLastOperation

default reactor.core.publisher.Mono<GetLastServiceBindingOperationResponse> getLastOperation(GetLastServiceBindingOperationRequest request)

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

Parameters:

request - containing the details of the request

Returns:

a GetLastServiceBindingOperationResponse on successful processing of the request

Throws:

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

ServiceInstanceBindingDoesNotExistException - if a binding with the given ID is not known to the broker

deleteServiceInstanceBinding

default reactor.core.publisher.Mono<DeleteServiceInstanceBindingResponse> deleteServiceInstanceBinding(DeleteServiceInstanceBindingRequest request)

Delete a service instance binding.

Parameters:

request - containing the details of the request

Returns:

a DeleteServiceInstanceBindingResponse on successful processing of the request

Throws:

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

ServiceInstanceBindingDoesNotExistException - if a binding with the given ID is not known to the broker

ServiceBrokerDeleteOperationInProgressException - if a an operation is in progress for the service binding

ServiceBrokerAsyncRequiredException - if the broker requires asynchronous processing of the request