A newer version of this documentation is available.

View Latest
January 19, 2025
+ 12

Description — Couchbase Lite on Java — a framework for developing offline-first Java applications for mobile and edge
Abstract — This content identities the pre-requisites and preparatory steps to be considered before installing Couchbase Lite for java

Introduction

Couchbase Lite on Java enables development and deployment of Couchbase Lite applications to a JVM environment. You can deploy to a desktop or web server (for example, Tomcat), including embedded Tomcat deployments.

We use Intellij IDEA, gradle, Maven and Tomcat as tools to build and run the examples presented in this content. You are free to use the tools of your choice.

Install Server Software

If you want to use Couchbase Lite on Java with Couchbase Server and-or Sync Gateway you will need to have installed operational instances of these before completing the installation and test build steps.

So, If you have not already done so, see Prepare Sync Gateway

  • Within Couchbase Server, create a bucket named getting-started.cblite2

  • Create a RBAC user for Sync Gateway with username = sync-gateway and password = password

MacOS and Windows

You may now proceed directly to Couchbase Lite on Java — Installing.

Additional Steps For Linux

Before proceeding to Couchbase Lite on Java — Installing, you will need to make the supplied support libraries available to your running application.

Steps

  1. Download the zip file from here — https://packages.couchbase.com/releases/couchbase-lite-java/3.1.10/couchbase-lite-java-linux-supportlibs-3.1.10.zip .

  2. Unpack the downloaded file to a location accessible to your build and runtime environments, for example your_dir/couchbase-lite-java-3.1.10.

  1. Set up the Native Libraries for Linux. You will need to add the path of the directory <lib-directory> to the value of the Java system property java.library.path.

Normally, the simplest way to set this is through the shell variable LD_LIBRARY_PATH.

Add the variables to your $CATALINA_BASE/bin/setenv.sh. (If the setenv.sh file doesn’t exist, you will need to create a new file.)

bashrc
LD_LIBRARY_PATH=<lib-directory>/support/libC++:<lib-directory>/support/libicu:$LD_LIBRARY_PATH

Please refer to the Linux Platform Support section for the minimum version requirements of those libraries.