Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Java Client for the OpenShift REST API

Merge pull request #218 from brenton/master

Crosslinking with the new repo
latest commit 4f4c303206
@brenton brenton authored
Failed to load latest commit information.
src Removing mms tests
.gitignore [OSJC-125] exclude DHE (SSL) ciphers when supported keys are <= 1024
.travis.yml add travis integration and badge
epl-v10.html Add required copy of EPL license text
license license
pom.xml bumping to 2.8.0-SNAPSHOT

OpenShift Java Client Build Status Maven Central

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.). This client is used by JBoss Tools for OpenShift 2.x. For later OpenShift versions see


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 which discuss the API in more details:

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

  • ApplicationResourceIntegrationTest
  • DomainResourceIntegrationTest
  • EmbeddedCartridgeResourceIntegrationTest
  • etc.


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

Something went wrong with that request. Please try again.