<dependencies>
    ...
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-service-broker-webmvc</artifactId>
        <version>${springCloudServiceBrokerVersion}</version>
    </dependency>

    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-open-service-broker</artifactId>
        <version>${springCloudServiceBrokerVersion}</version>
        <classifier>tests</classifier>
        <scope>test</scope>
    </dependency>
    ...
</dependencies>

dependencies {
    ...
    compile("org.springframework.cloud:spring-cloud-starter-service-broker-webmvc:${springCloudServiceBrokerVersion}")
    testCompile(group: "org.springframework.cloud", name: "spring-cloud-open-service-broker", version: "${springCloudServiceBrokerVersion}", classifier: "tests")
    ...
}

@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

The Cloud Foundry service broker API has three main endpoint groupings: catalog management, service instance provisioning/deprovisioning, and service instance binding/unbinding. The broker will need to provide one Spring bean to provide the necessary functionality for each endpoint grouping.

For catalog management, the framework provides a default implementation that requires the broker to just provide an implementation of a Catalog bean. There is an example of this approach in the MongoDB sample broker. To override this default, provide your own bean that implements the CatalogService interface.

For service instance provisioning/deprovisioning, provide a Spring bean that implements the ServiceInstanceService interface. There is no default implementation provided.

For service instance binding/unbinding, provide a Spring bean that implements the ServiceInstanceBindingService interface. If the service broker does not provide any bindable services, this bean can be omitted and a default implementation will be provided.

The project includes the spring-boot-starter-security project. See the Spring Boot Security documentation for configuration options.

The default behavior creates a user called user with a generated password that is logged as an INFO message during app startup. For example:

If you are deploying your service broker to Cloud Foundry as an app, be aware the password is re-generated every time you push the application. Therefore, you need to run cf update-service-broker with the new password after each push.

To see the generated password in the application logs on Cloud Foundry, use one of the following commands:

By default, the framework will verify the version of the service broker API for each request it receives. To disable service broker API version header verification, provide a BrokerApiVersion bean that accepts any API version:

The project is built with Gradle. The Gradle wrapper allows you to build the project on multiple platforms and even if you do not have Gradle installed; run it in place of the gradle command (as ./gradlew) from the root of the main project directory.