Skip to content

Commit ee77cf5

Browse files
twoseattwoseat
committed
Merge branch 'doc-update' into 3.x
2 parents c28bd64 + 37c02a6 commit ee77cf5

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

‎README.md‎

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,30 @@
33

44
| Artifact | Javadocs
55
| -------- | --------
6-
| `cloudfoundry-client` | [![Javadocs](https://javadoc.io/badge/org.cloudfoundry/cloudfoundry-client.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-client)
7-
| `cloudfoundry-client-reactor` | [![Javadocs](https://javadoc.io/badge/org.cloudfoundry/cloudfoundry-client-reactor.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-client-reactor)
8-
| `cloudfoundry-operations` | [![Javadocs](https://javadoc.io/badge/org.cloudfoundry/cloudfoundry-operations.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-operations)
9-
| `cloudfoundry-util` | [![Javadocs](https://javadoc.io/badge/org.cloudfoundry/cloudfoundry-util.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-util)
6+
| `cloudfoundry-client` | [![javadocs](https://javadoc.io/badge2/org.cloudfoundry/cloudfoundry-client/3.17.1.RELEASE/javadoc.io.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-client/3.17.1.RELEASE) |
7+
| `cloudfoundry-client-reactor` | [![javadocs](https://javadoc.io/badge2/org.cloudfoundry/cloudfoundry-client-reactor/3.17.1.RELEASE/javadoc.io.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-client-reactor/3.17.1.RELEASE) |
8+
| `cloudfoundry-operations` | [![javadocs](https://javadoc.io/badge2/org.cloudfoundry/cloudfoundry-operations/3.17.1.RELEASE/javadoc.io.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-operations/3.17.1.RELEASE) |
9+
| `cloudfoundry-util` | [![javadocs](https://javadoc.io/badge2/org.cloudfoundry/cloudfoundry-util/3.17.1.RELEASE/javadoc.io.svg)](https://javadoc.io/doc/org.cloudfoundry/cloudfoundry-util/3.17.1.RELEASE) |
1010

1111
| Job | Status
1212
| --- | ------
13-
| `unit-test` | [![unit-test-master](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/unit-test-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/unit-test-master)
14-
| `integration-test-2.1` | [![unit-test-master](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.1-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.1-master)
15-
| `integration-test-2.2` | [![unit-test-master](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.2-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.2-master)
16-
| `integration-test-2.3` | [![unit-test-master](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.3-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.3-master)
17-
| `integration-test-2.4` | [![unit-test-master](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.3-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.4-master)
18-
| `deploy` | [![deploy-master](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/deploy-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/deploy-master)
13+
| `unit-test` | [![unit-test-3.x](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/unit-test-3.x/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/unit-test-3.x)
14+
| `integration-test-2.1` | [![unit-test-3.x](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.1-3.x/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.1-3.x)
15+
| `integration-test-2.2` | [![unit-test-3.x](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.2-3.x/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.2-3.x)
16+
| `integration-test-2.3` | [![unit-test-3.x](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.3-3.x/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.3-3.x)
17+
| `integration-test-2.4` | [![unit-test-3.x](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/integration-test-2.3-3.x/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/integration-test-2.4-3.x)
18+
| `deploy` | [![deploy-3.x](https://java-experience.ci.springapps.io/api/v1/teams/java-experience/pipelines/java-client/jobs/deploy-master/badge)](https://java-experience.ci.springapps.io/teams/java-experience/pipelines/java-client/jobs/deploy-3.x)
1919

2020

21-
The `cf-java-client` project is a Java language binding for interacting with a Cloud Foundry instance. The project is broken up into a number of components which expose different levels of abstraction depending on need.
21+
The `cf-java-client` project is a Java language binding for interacting with a Cloud Foundry instance. The project is broken up into a number of components that expose different levels of abstraction depending on need.
2222

23-
* `cloudfoundry-client` – Interfaces, request, and response objects mapping to the [Cloud Foundry REST APIs][a]. This project has no implementation and therefore cannot connect a Cloud Foundry instance on its own.
23+
* `cloudfoundry-client` – Interfaces, request, and response objects mapping to the [Cloud Foundry REST APIs][a]. This project has no implementation and therefore cannot connect to a Cloud Foundry instance on its own.
2424
* `cloudfoundry-client-reactor` – The default implementation of the `cloudfoundry-client` project. This implementation is based on the Reactor Netty [`HttpClient`][h].
2525
* `cloudfoundry-operations` – An API and implementation that corresponds to the [Cloud Foundry CLI][c] operations. This project builds on the `cloudfoundry-client` and therefore has a single implementation.
2626

27+
## Versions
28+
The Cloud Foundry Java Client has two active versions. The `4.x` line uses Spring Boot `2.2.x` just to manage its dependencies, while the `3.x` line uses Spring Boot `2.1.x`. Unless you have a specific dependency-related reason for using the older version we recommend you adopt the `4.x` line.
29+
2730
## Dependencies
2831
Most projects will need two dependencies; the Operations API and an implementation of the Client API. For Maven, the dependencies would be defined like this:
2932

@@ -32,12 +35,12 @@ Most projects will need two dependencies; the Operations API and an implementati
3235
<dependency>
3336
<groupId>org.cloudfoundry</groupId>
3437
<artifactId>cloudfoundry-client-reactor</artifactId>
35-
<version>3.15.0.RELEASE</version>
38+
<version>3.17.1.RELEASE</version>
3639
</dependency>
3740
<dependency>
3841
<groupId>org.cloudfoundry</groupId>
3942
<artifactId>cloudfoundry-operations</artifactId>
40-
<version>3.15.0.RELEASE</version>
43+
<version>3.17.1.RELEASE</version>
4144
</dependency>
4245
<dependency>
4346
<groupId>io.projectreactor</groupId>
@@ -47,7 +50,7 @@ Most projects will need two dependencies; the Operations API and an implementati
4750
<dependency>
4851
<groupId>io.projectreactor.ipc</groupId>
4952
<artifactId>reactor-netty</artifactId>
50-
<version>0.7.15.RELEASE</version>
53+
<version>0.8.13.RELEASE</version>
5154
</dependency>
5255
...
5356
</dependencies>
@@ -73,10 +76,10 @@ For Gradle, the dependencies would be defined like this:
7376

7477
```groovy
7578
dependencies {
76-
compile 'org.cloudfoundry:cloudfoundry-client-reactor:3.15.0.RELEASE'
77-
compile 'org.cloudfoundry:cloudfoundry-operations:3.15.0.RELEASE'
79+
compile 'org.cloudfoundry:cloudfoundry-client-reactor:3.17.1.RELEASE'
80+
compile 'org.cloudfoundry:cloudfoundry-operations:3.17.1.RELEASE'
7881
compile 'io.projectreactor:reactor-core:3.2.12.RELEASE'
79-
compile 'io.projectreactor.ipc:reactor-netty:0.7.15.RELEASE'
82+
compile 'io.projectreactor.ipc:reactor-netty:0.8.13.RELEASE'
8083
...
8184
}
8285
```
@@ -249,7 +252,7 @@ cloudFoundryClient.organizations()
249252

250253
The above example is more complicated:
251254

252-
1. `.list(...)` – Retrieves a page of Cloud Foundry organizations.
255+
1. `.list(...)` – Retrieves the first page of Cloud Foundry organizations.
253256
1. `.flatMapIterable(...)` – Substitutes the original `Mono` with a `Flux` of the `Resource`s returned by the requested page.
254257
1. `.map(...)` – Maps the `Resource` to an `OrganizationSummary` type.
255258

@@ -261,7 +264,7 @@ $ git submodule update --init --recursive
261264
$ ./mvnw clean install
262265
```
263266

264-
It also depends on [Immutables](https://immutables.github.io/) and won't compile in IDEs like Eclipse or IntelliJ unless you also have an enabled annotation processor. See [this guide](https://immutables.github.io/apt.html) for instructions on how to configure your IDE.
267+
It also depends on [Immutables][i] and won't compile in IDEs like Eclipse or IntelliJ unless you also have an enabled annotation processor. See [this guide][j] for instructions on how to configure your IDE.
265268

266269
To run the integration tests, run the following:
267270

@@ -272,7 +275,7 @@ $ ./mvnw -Pintegration-test clean test
272275
**IMPORTANT**
273276
Integration tests should be run against an empty Cloud Foundry instance. The integration tests are destructive, affecting nearly everything on an instance given the chance.
274277

275-
The integration tests require a running instance of Cloud Foundry to test against. We recommend using [PCF Dev][i] to start a local instance to test with. To configure the integration tests with the appropriate connection information use the following environment variables:
278+
The integration tests require a running instance of Cloud Foundry to test against. To configure the integration tests with the appropriate connection information use the following environment variables:
276279

277280
Name | Description
278281
---- | -----------
@@ -298,7 +301,8 @@ This project is released under version 2.0 of the [Apache License][l].
298301
[e]: https://github.com/cloudfoundry/java-client/issues
299302
[g]: https://gradle.org
300303
[h]: https://projectreactor.io/docs/netty/milestone/reference/index.html#http-client
301-
[i]: https://github.com/pivotal-cf/pcfdev
304+
[i]: https://immutables.github.io/
305+
[j]: https://immutables.github.io/apt.html
302306
[l]: https://www.apache.org/licenses/LICENSE-2.0
303307
[m]: https://maven.apache.org
304308
[p]: https://projectreactor.io

0 commit comments

Comments
 (0)