Skip to content

cuecloud/cuecloud-java

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 

Repository files navigation

cuecloud API - Java Client Library

This Project provides a CueCloud API wrapper for Java.

Dependancies

  1. Apache Codecs Library
  2. FlexJson Library

These dependancies are pre-packaged in the library available in the links below. However, it is advisable that you use the versions from the above links as they are guaranteed to be the most recent versions.

Initial Setup

You can download the JAR file plus dependencies from https://www.cuecloud.com/api/java/cuecloud-java-bin.zip. Add the downloaded files as library dependencies in your IDE or add the jar files in the classpath of your target system if you wish to use the library in a commandline or Server based Java program.

The Javadoc for this library is at https://www.cuecloud.com/api/java/javadoc. You can reference this URL directly in your IDE as the JavaDoc Source for the libray. Alternatively, and preferrably for speed, Download the Java Doc zip file from https://www.cuecloud.com/api/java/cuecloud-javadoc.zip and attach it as javadoc source in your IDE.

Quick Start Guide

You will need API KEY and API PASSWORD from http://www.cuecloud.com/

Once you have the API KEY and API PASSWORD, Create or Open the target Project in your favorite IDE and Create a CueCloud Object as shown below:

private static final String YOUR_API_KEY ="your.cuecloud.api.key";
private static final String YOUR_API_PASS="your.cuecloud.api.pass";
private CueCloud cueCloud;
    try {
        cueCloud = new CueCloud(YOUR_API_KEY, YOUR_API_PASS);
    } catch (CueCloud.CueCloudException ex) {
        Logger.getLogger(CueCloudTest.class.getName()).log(Level.SEVERE, ""+ex.getMessage(),ex);
        // TODO: Tell user about the error in a friendly manner
    }

For developers or Individuals hosting cuecloud server instance locally for development or testing purpose, you can specify localhost as the URL to make requests to your local instance.

private static final String YOUR_API_KEY ="your.cuecloud.api.key";
private static final String YOUR_API_PASS="your.cuecloud.api.pass";
private CueCloud cueCloud;
    try {
        cueCloud = new CueCloud(YOUR_API_KEY, YOUR_API_PASS, "http://localhost");
    } catch (CueCloud.CueCloudException ex) {
        Logger.getLogger(CueCloudTest.class.getName()).log(Level.SEVERE, ""+ex.getMessage(),ex);
        // TODO: Tell user about the error in a friendly manner
    }

Once you have a CueCloud Java Object, you can make your target method calls. Be sure to catch CueCloudExcepton if thrown by the target method.

cuecloud.validateUser();

JUnit Tests

This repository ships with JUnit tests for the project. You can clone the repository or download as Zip file to access and run the Junit Tests in your favorite IDE. Running the Junit Tests will require Junit-4.x library.

Copyright and license

Copyright 2014 CueCloud. Licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages