# openshift-java-client

**Repository Path**: mirrors_openshift/openshift-java-client

## Basic Information

- **Project Name**: openshift-java-client
- **Description**: Java Client for the OpenShift REST API
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

OpenShift Java Client [![Build Status](https://travis-ci.org/openshift/openshift-java-client.svg)](https://travis-ci.org/openshift/openshift-java-client)  [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.openshift/openshift-java-client/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.openshift/openshift-java-client)
===========================

Java client for the OpenShift REST API.  It pretty much offers all features that are currently available in the rhc-* command line tools 
(create/rename a domain, create/destroy applications, list applications, list available cartridges, add cartridges, etc.). 

Only for Version 2
----------------

This client is used by JBoss Tools for OpenShift 2.x.

For later OpenShift versions see https://github.com/openshift/openshift-restclient-java/.

Usage
-----
An exemplary usage of the client may look like the following:

		IOpenShiftConnection connection = 
				new OpenShiftConnectionFactory().getConnection("myApplicationId", "user", "password");
		IUser user = connection.getUser();
		IDomain domain = user.createDomain("myDomain");
		IApplication as7Application = domain.createApplication("myApplication", LatestVersionOf.jbossAs().get(user));
		IEmbeddedCartridge mySqlCartridge = as7Application.addEmbeddableCartridge(LatestVersionOf.mySQL().get(user));
		String unstructuredCredentials = mySqlCartridge.getCreationLog();
		String mySqlConnectionUrl = mySqlCartridge.getUrl();

There are also 2 blog posts on jboss.org which discuss the API in more details:

* [show-domain-info: openshift-java-client in a nutshell](http://planet.jboss.org/post/show_domain_info_openshift_java_client_in_a_nutshell)
* [enable-openshift-ci: full example using openshift-java-client](https://community.jboss.org/wiki/Enable-openshift-ciFullExampleUsingOpenshift-java-client)

Most insightful are the integration tests within the library which pretty much use the API in all details:

* ApplicationResourceIntegrationTest
* DomainResourceIntegrationTest
* EmbeddedCartridgeResourceIntegrationTest
* etc. 

Download
--------
You may either build from source using maven (mvn clean package) or get the prebuilt artifact from the maven central.