com.cloudant.client.api

Class CloudantClient

java.lang.Object

com.cloudant.client.api.CloudantClient

public class CloudantClient
extends java.lang.Object

Exposes the Cloudant client API

This class is the main object to use to gain access to the Cloudant APIs.

Usage Examples:

Create a new Cloudant client instance

CloudantClient client = new CloudantClient("mycloudantaccount","myusername","mypassword");

Client use of the API

• Server APIs accessed by the client directly e.g.:

  client.getAllDbs()

• DB is accessed by getting the Database from the client e.g.:

  Database db = client.database("customers",false);

• Document CRUD APIs accessed from the Database e.g.:

  db.find(Foo.class, "doc-id")

Cloudant Query

• Create an index Database.createIndex(String, String, String, IndexField[]) e.g.:

  db.createIndex("Person_name", "Person_name_design_doc", "json", new IndexField[] { new IndexField ("Person_name",SortOrder.asc)})

• Find using an index Database.findByIndex(String, Class) e.g.:

  db.findByIndex(" "selector": { "Person_name": "Alec Guinness" }", Movie.class)}

• Delete an index Database.deleteIndex(String, String) e.g.:

  db.deleteIndex("Person_name", "Person_name_design_doc")

Cloudant Search

db.search("views101/animals)

View APIs

db.view()

Change Notifications

db.changes()

Design Documents

db.design()

Replication

Replication account.replication() and account.replicator()

Shutting down

At the end of a client usage; it's useful to call client.shutdown() to ensure proper release of resources.

Since:

0.0.1

Constructor Summary

Constructors

Constructor and Description
CloudantClient(java.lang.String account, java.lang.String authCookie) Constructs a new instance of this class and connects to the cloudant account with the specified credentials
CloudantClient(java.lang.String account, java.lang.String authCookie, ConnectOptions connectOptions) Constructs a new instance of this class and connects to the cloudant account with the specified credentials
CloudantClient(java.lang.String account, java.lang.String loginUsername, java.lang.String password) Constructs a new instance of this class and connects to the cloudant server with the specified credentials
CloudantClient(java.lang.String account, java.lang.String loginUsername, java.lang.String password, ConnectOptions connectOptions) Constructs a new instance of this class and connects to the cloudant account with the specified credentials

Method Summary

Modifier and Type	Method and Description
void	createDB(java.lang.String dbName) Request to create a new database; if one doesn't exist.
Database	database(java.lang.String name, boolean create) Get a database
void	deleteDB(java.lang.String dbName) Request to delete a database.
void	deleteDB(java.lang.String dbName, java.lang.String confirm) Deprecated. use deleteDB(String)
org.apache.http.HttpResponse	executeRequest(org.apache.http.client.methods.HttpRequestBase request) Executes a HTTP request.
ApiKey	generateApiKey() Generate an API key
java.util.List<Task>	getActiveTasks() Get all active tasks
java.util.List<java.lang.String>	getAllDbs()
java.net.URI	getBaseUri()
java.lang.String	getCookie() Get the cookieStore
com.google.gson.Gson	getGson()
Membership	getMembership() Get the list of nodes in a cluster
Replication	replication() Provides access to Cloudant replication APIs.
Replicator	replicator() Provides access to Cloudant replication APIs.
java.lang.String	serverVersion()
void	setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder) Sets a GsonBuilder to create Gson instance.
void	shutdown() Shuts down the connection manager used by this client instance.
java.util.List<java.lang.String>	uuids(long count) Request cloudant to send a list of UUIDs.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudantClient

public CloudantClient(java.lang.String account,
                      java.lang.String loginUsername,
                      java.lang.String password)

Constructs a new instance of this class and connects to the cloudant server with the specified credentials

Parameters:

account - For cloudant.com, the cloudant account to connect to. For Cloudant local, the server URL

loginUsername - The apiKey (if using an APIKey, else pass in the account for this parameter also)

password - The Password credential

CloudantClient

public CloudantClient(java.lang.String account,
                      java.lang.String loginUsername,
                      java.lang.String password,
                      ConnectOptions connectOptions)

Constructs a new instance of this class and connects to the cloudant account with the specified credentials

Parameters:

account - For cloudant.com, the cloudant account to connect to. For Cloudant local, the server URL

loginUsername - The apiKey (if using an APIKey, else pass in the account for this parameter also)

password - The Password credential

connectOptions - optional properties to connect e.g connectionTime,socketTimeout,etc

CloudantClient

public CloudantClient(java.lang.String account,
                      java.lang.String authCookie)

Constructs a new instance of this class and connects to the cloudant account with the specified credentials

Parameters:

account - For cloudant.com, the cloudant account to connect to. For Cloudant local, the server URL

authCookie - The cookie obtained from last login

CloudantClient

public CloudantClient(java.lang.String account,
                      java.lang.String authCookie,
                      ConnectOptions connectOptions)

Constructs a new instance of this class and connects to the cloudant account with the specified credentials

Parameters:

account - For cloudant.com, the cloudant account to connect to. For Cloudant local, the server URL

account - The cloudant account to connect to

authCookie - The cookie obtained from last login

connectOptions - optional properties to connect e.g connectionTime,socketTimeout,etc

Method Detail

generateApiKey

public ApiKey generateApiKey()

Generate an API key

Returns:

the generated key and password

getActiveTasks

public java.util.List<Task> getActiveTasks()

Get all active tasks

Returns:

List of tasks

getCookie

public java.lang.String getCookie()

Get the cookieStore

Returns:

cookieStore

getMembership

public Membership getMembership()

Get the list of nodes in a cluster

Returns:

cluster nodes and all nodes

database

public Database database(java.lang.String name,
                         boolean create)

Get a database

Parameters:

name - name of database to access

create - flag indicating whether to create the database if doesnt exist.

Returns:

Database object

deleteDB

@Deprecated
public void deleteDB(java.lang.String dbName,
                                 java.lang.String confirm)

Deprecated. use deleteDB(String)

Request to delete a database.

Parameters:

dbName - The database name

confirm - A confirmation string with the value: delete database

deleteDB

public void deleteDB(java.lang.String dbName)

Request to delete a database.

Parameters:

dbName - The database name

createDB

public void createDB(java.lang.String dbName)

Request to create a new database; if one doesn't exist.

Parameters:

dbName - The Database name

getBaseUri

public java.net.URI getBaseUri()

Returns:

The base URI.

getAllDbs

public java.util.List<java.lang.String> getAllDbs()

Returns:

All Server databases.

serverVersion

public java.lang.String serverVersion()

Returns:

Cloudant Server version.

replication

public Replication replication()

Provides access to Cloudant replication APIs.

See Also:

Replication

replicator

public Replicator replicator()

Provides access to Cloudant replication APIs.

See Also:

Replication

executeRequest

public org.apache.http.HttpResponse executeRequest(org.apache.http.client.methods.HttpRequestBase request)

Executes a HTTP request. This method provides a mechanism to extend the API

Note: The response must be closed after use to release the connection.

Parameters:

request - The HTTP request to execute.

Returns:

HttpResponse

shutdown

public void shutdown()

Shuts down the connection manager used by this client instance.

uuids

public java.util.List<java.lang.String> uuids(long count)

Request cloudant to send a list of UUIDs.

Parameters:

count - The count of UUIDs.

setGsonBuilder

public void setGsonBuilder(com.google.gson.GsonBuilder gsonBuilder)

Sets a GsonBuilder to create Gson instance.

Useful for registering custom serializers/deserializers, such as Datetime formats.

getGson

public com.google.gson.Gson getGson()

Returns:

The Gson instance.