org.lightcouch

Class CouchDbClient

java.lang.Object

org.lightcouch.CouchDbClientBase

org.lightcouch.CouchDbClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class CouchDbClient
extends CouchDbClientBase
implements java.io.Closeable

Presents a client to CouchDB database server.

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

Usage Example:

Create a new client instance:

 CouchDbClient dbClient = new CouchDbClient();
 

Start using the API by the client:

Documents CRUD APIs is accessed by the client directly, eg.: dbClient.find(Foo.class, "doc-id")

View APIs dbClient.view()

Change Notifications dbClient.changes()

Replication dbClient.replication() and dbClient.replicator()

DB server dbClient.context()

Design documents dbClient.design()

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

Since:

0.0.2

Author:

Ahmed Yehia

See Also:

CouchDbClientAndroid

Constructor Summary

Constructors

Constructor and Description
CouchDbClient() Constructs a new instance of this class, expects a configuration file named couchdb.properties to be available in your application default classpath.
CouchDbClient(CouchDbProperties properties) Constructs a new instance of this class.
CouchDbClient(java.lang.String configFileName) Constructs a new instance of this class.
CouchDbClient(java.lang.String dbName, boolean createDbIfNotExist, java.lang.String protocol, java.lang.String host, int port, java.lang.String username, java.lang.String password) Constructs a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	close()
void	shutdown() Shuts down the connection manager used by this client instance.

Methods inherited from class org.lightcouch.CouchDbClientBase

batch, bulk, changes, contains, context, design, executeRequest, find, find, find, find, find, findAny, findDocs, getBaseUri, getDBUri, getGson, invokeUpdateHandler, post, remove, remove, replication, replicator, save, saveAttachment, saveAttachment, setGsonBuilder, syncDesignDocsWithDb, update, view

Methods inherited from class java.lang.Object

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

Constructor Detail

CouchDbClient

public CouchDbClient()

Constructs a new instance of this class, expects a configuration file named couchdb.properties to be available in your application default classpath.

CouchDbClient

public CouchDbClient(java.lang.String configFileName)

Constructs a new instance of this class.

Parameters:

configFileName - The configuration file name.

CouchDbClient

public CouchDbClient(java.lang.String dbName,
                     boolean createDbIfNotExist,
                     java.lang.String protocol,
                     java.lang.String host,
                     int port,
                     java.lang.String username,
                     java.lang.String password)

Constructs a new instance of this class.

Parameters:

dbName - The database name.

createDbIfNotExist - To create a new database if it does not already exist.

protocol - The protocol to use (i.e http or https)

host - The database host address

port - The database listening port

username - The Username credential

password - The Password credential

CouchDbClient

public CouchDbClient(CouchDbProperties properties)

Constructs a new instance of this class.

Parameters:

properties - An object containing configuration properties.

See Also:

CouchDbProperties

Method Detail

shutdown

public void shutdown()

Description copied from class: CouchDbClientBase

Shuts down the connection manager used by this client instance.

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException