Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Cloud Foundry - the open platform as a service project
Java Other
Latest commit a3972f1 @Zteve Zteve Merge 107069280-list-service-bindings to master
[Completes #107069280]


The cf-java-client repo contains a Java client library and tools for Cloud Foundry. Three major components are included in this repo.



The cloudfoundry-client-lib is a Java library that provides a Java language binding for the Cloud Foundry Cloud Controller REST API. The library can be used by Java, Groovy, and Scala apps to interact with a Cloud Foundry service on behalf of a user.

Read more


The Cloud Foundry Maven plugin is a plugin for the Maven build tool that allows you to deploy and manage applications with Maven goals.

Read more


The Cloud Foundry Gradle plugin is a plugin for the Gradle build tool that allows you to deploy and manage applications with Gradle tasks.

Read more



Apache Maven

The cloudfoundry-client-lib and cloudfoundry-maven-plugin components are built with Apache Maven.


The cloudfoundry-gradle-plugin component is built with Gradle.

Protocol Buffer compiler

The cloudfoundry-client-lib uses Protocol Buffers to get logs from the Cloud Foundry loggregator component. A protoc Protocol Buffer compiler is required at build time to compile message specifications. protoc version 2.6.1 is required.

On Linux with apt, run the script in this repository to compile protoc from source.

On OSX, run the script to install protoc. Alternatively you can install protobuf using homebrew if homebrew supports the appropriate version.

On Windows, download the protoc binary zip file from the releases page, unzip it, and put protoc.exe in the path.

After installing, run this command and check the output to make sure it is similar to the following:

$ protoc --version
libprotoc 2.6.1

Compiling and Packaging

To build cloudfoundry-client-lib and cloudfoundry-maven-plugin, run the following command from the project root directory:

$ mvn clean install

To build cloudfoundry-gradle-plugin, run the following command from the cloudfoundry-gradle-plugin sub-directory after building cloudfoundry-client-lib:

$ gradle clean install

Running Integration Tests

cloudfoundry-client-lib has an extensive set of integration tests which run against a Cloud Foundry service. To execute the integration tests, run the following command from the project root directory:

$ mvn -P integration-test clean install<endpoint><username> -Dccng.passwd=<password><organization><space>

Following is a complete list of the -D parameters that can be passed to the integration test:

Parameter Description Required/Optional target Cloud Foundry endpoint (e.g. required Cloud Foundry username required
ccng.passwd Cloud Foundry password required Cloud Foundry organization to run tests against required Cloud Foundry space to run tests against required
ccng.ssl trust self-signed certificates from target endpoint optional, default is false
vcap.mysql.label label of a MySQL service that can be created optional, default is cleardb
vcap.mysql.plan plan of a MySQL service that can be created optional, default is spark
http.proxyHost host name of an HTTP proxy optional
http.proxyPort port of an HTTP proxy optional


Integration tests should be run against an empty Cloud Foundry space. The integration tests are destructive, and will delete any apps, services, routes, and domains existing in the target space.

Cloud Foundry Resources

Cloud Foundry Open Source Platform as a Service


Our documentation, currently a work in progress, is available here:

Ask Questions

Questions about the Cloud Foundry Open Source Project can be directed to our Mailing Lists.

File a bug

Bugs can be filed using Github Issues within the various repositories of the Cloud Foundry components, including for this project

OSS Contributions

The Cloud Foundry team uses GitHub and accepts contributions via pull request

Follow these steps to make a contribution to any of our open source repositories:

  1. Complete our CLA Agreement for individuals or corporations
  2. Set your name and email
$ git config --global "Firstname Lastname"
$ git config --global ""
  1. Fork the repo
  2. Make your changes on a topic branch, commit, and push to github and open a pull request.

Once your commits are approved by Concourse CI and reviewed by the core team, they will be merged.

Something went wrong with that request. Please try again.