Java client is built on the top of jclouds for working with Jenkins REST API.
Client's can be built like so:
JenkinsClient client = JenkinsClient.builder()
.endPoint("http://127.0.0.1:8080") // Optional. Defaults to http://127.0.0.1:8080
.credentials("admin:password") // Optional.
.build();
SystemInfo systemInfo = client.api().systemApi().systemInfo();
assertTrue(systemInfo.jenkinsVersion().equals("1.642.4"));
Can be found in jcenter like so:
<dependency>
<groupId>com.cdancy</groupId>
<artifactId>jenkins-rest</artifactId>
<version>X.Y.Z</version>
<classifier>sources|tests|javadoc|all</classifier> (Optional)
</dependency>
- javadocs can be found via github pages here
- the jenkins-rest wiki
Client instances do NOT need to supply the endPoint or credentials as a part of instantiating the JenkinsClient object. Instead one can supply them through system properties, environment variables, or a combination of the two. System properties will be searched first and if not found, will attempt to query the environment.
Setting the endpoint can be done with any of the following (searched in order):
jenkins.rest.endpointjenkinsRestEndpointJENKINS_REST_ENDPOINT
Setting the credentials can be done with any of the following (searched in order):
jenkins.rest.credentialsjenkinsRestCredentialsJENKINS_REST_CREDENTIALS
jenkins-rest credentials can take 1 of 2 forms:
- Colon delimited username and password: admin:password
- Base64 encoded username and password: YWRtaW46cGFzc3dvcmQ=
The mock and live tests provide many examples that you can use in your own code.
- jclouds - used as the backend for communicating with Jenkins REST API
- AutoValue - used to create immutable value types both to and from the jenkins program
Running mock tests can be done like so:
./gradlew clean build mockTest
Running integration tests can be done like so (requires existing jenkins instance):
./gradlew clean build integTest