Package org.springframework.cloud.servicebroker.service

Interface CatalogService

All Known Implementing Classes:
BeanCatalogService
public interface CatalogService
This interface is implemented by service brokers to process requests to retrieve the service catalog.
Author:
S Greenberg, Roy Clarkson

  • Method Details

    • getCatalog

      reactor.core.publisher.Mono<Catalog> getCatalog()
      Return the catalog of services provided by the service broker.
      Returns:
      the catalog of services

    • getServiceDefinition

      reactor.core.publisher.Mono<ServiceDefinition> getServiceDefinition(String serviceId)
      Get a service definition from the catalog by ID.
      Parameters:
      serviceId - the ID of the service definition in the catalog
      Returns:
      the service definition, or null if it doesn't exist

    • getResponseEntityCatalog

      default reactor.core.publisher.Mono<ResponseEntity<Catalog>> getResponseEntityCatalog(HttpHeaders httpHeaders)
      Return the ResponseEntity with catalog of services provided by the service broker. Implementing service brokers may use this method to manage ETag responses and caching of the catalog. This ResponseEntity returned by this method is directly returned in the CatalogController.getCatalog(HttpHeaders) method.
      Parameters:
      httpHeaders - the HttpHeaders from the request
      Returns:
      the ResponseEntity with catalog or an appropriate ETag response