Java Driver

Current version: 1.0.48. Released May 18, 2023.

The Cloud CMS Java driver makes it easy for your Java and Android applications to connect to and communicate with the Cloud CMS server. The driver can be utilized with Android mobile devices as well as Java applications running on the server or as a web application (Spring Framework, SEAM, etc, running on Tomcat, Glassfish, WebSphere and many other frameworks).

Maven Repository

Cloud CMS runs a Maven repository where it hosts its Java-related assets including the Cloud CMS driver. If you're building using Maven, Ivy, Gradle or another build framework that manages dependencies, you can probably take advantage of this repository.

For Maven users, you can add the following repository configuration:

    
<repositories>
    <repository>
        <id>cloudcms-public</id>
        <name>cloudcms-public</name>
        <url>http://maven.cloudcms.com/public</url>
    </repository>
</repositories>
    

You can then add the Java Driver as a dependency to your pom.xml file:

<dependencies>
    <dependency>
        <groupId>org.gitana</groupId>
        <artifactId>gitana-java-driver</artifactId>
        <version>1.0.48</version>
    </dependency>
</dependencies>

Getting Started

To connect to Cloud CMS, you first need to have a set of API Keys. In Cloud CMS, API Keys consists of a client key/secret and a user key/secret. You pass these keys into the Gitana.connect method as a JSON object.

You can create as many API Keys as you would like. The basic process for getting your own keys is described in the Developers Getting Started Guide. Give that a shot and when you're done, you should have the following:

• clientKey
• clientSecret
• username
• password

You can then connect to Cloud CMS using a code block like the one shown below. Make sure to plug in the values for clientKey, clientSecret, username and password from the API Keys that you generate.

package com.cloudcms;

import org.gitana.platform.client.branch.Branch;
import org.gitana.platform.client.datastore.DataStore;
import org.gitana.platform.client.node.BaseNode;
import org.gitana.platform.client.node.Node;
import org.gitana.platform.client.platform.Platform;
import org.gitana.platform.client.platform.PlatformDataStore;
import org.gitana.platform.client.project.Project;
import org.gitana.platform.client.repository.Repository;
import org.gitana.platform.support.Pagination;
import org.gitana.platform.support.QueryBuilder;
import org.gitana.platform.support.ResultMap;
import org.gitana.platform.client.Gitana;

import java.util.List;

public class CloudCMSExample {

    public static void main(String[] args) {

        // these values come from your API Keys
        String clientKey = "{clientKey}";
        String clientSecret = "{clientSecret}";
        String username = "{username}";
        String password = "{password}";

        // connect to Cloud CMS as your application user
        Gitana gitana = new Gitana(clientKey, clientSecret);
        Platform platform = gitana.authenticate(username, password);

        // find my project
        Project myProject = null;
        List projectList = platform.listProjects().asList();
        for (Project project : projectList) {
            if (project.getTitle().equalsIgnoreCase("My Project Title")) {
                myProject = project;
                break;
            }
        }

        // there are a few data stores in each project. we want the 'Content' repository
        Repository myRepository = null;
        List datastores = myProject.getStack().listDataStores().asList();
        for (DataStore dataStore : datastores) {
            if (dataStore.getTypeId().equalsIgnoreCase("repository")) {
                // this is the content repository for this project
                myRepository = (Repository)dataStore;
                break;
            }
        }

        // get the master branch
        Branch master = myRepository.readBranch("master");

        Node node1 = (Node) master.createNode();
        Node node2 = (Node) master.createNode();
        Node node3 = (Node) master.createNode();

        // update a node
        node2.set("axl", "rose");
        node2.update();

        // delete the third node
        node3.delete();

        // query for nodes
        ResultMap nodes = master.queryNodes(QueryBuilder.start("axl").is("rose").get(), new Pagination(0,2));
        for (BaseNode node: nodes.values()) {
            System.out.println("id: " + node.getId());
            System.out.println("axl: " + node.get("axl"));
        }
    }
}