---
title: Installing Java SDK
slug: v4-4/installing-java-sdk
docTags: 
createdAt: 2023-07-28T20:16:57.748Z
---

You can integrate the Ditto SDK into Kotlin projects to develop for the Android platform. 

:::hint{type="info"}
For a complete overview of the platforms, transports, and devices the Java SDK supports, see [Compatibility with Java](docId\:aKby1JWuRoyyVz6RyuoTo).
:::

To install the Java SDK:

::::WorkflowBlock
:::WorkflowBlockItem
Confirm that you meet the minimum requirements. ([Prerequisites](./#prerequisites))
:::

:::WorkflowBlockItem
Prepare your environment for Ditto. ([Setting Up Your Environment](./#setting-up-your-environment))
:::

:::WorkflowBlockItem
Set up your app permissions. ([Configuring Permissions](./#configuring-permissions))
:::

:::WorkflowBlockItem
Add Ditto to your app. ([Integrating Ditto](./#integrating-ditto))
:::
::::

# Prerequisites

Following are the minimum requirements that must be met before attempting to install Ditto.

- Android version 6.0 (Marshmallow) or later
- `minSdk` version 23.0 or later
- `compileSdk` version 31.0 or later
- Java Development Kit (JDK) version 11.0 or later

# Setting Up Your Environment

:::::WorkflowBlock
::::WorkflowBlockItem
Confirm that `mavenCentral()` is in the project-level `build.gradle`:

:::CodeblockTabs
Bash

```none
allprojects {
    repositories {
        mavenCentral()
    }
}
```
:::
::::

::::WorkflowBlockItem
In the individual module `build.gradle` file:

:::CodeblockTabs
Bash

```none
dependencies {
  // ...
  implementation "live.ditto:ditto:4.+"
}
```
:::
::::
:::::

# Configuring Permissions

The Android operating system limits access to some device functionality for end-user control and privacy. 

To fully unlock Ditto's capabilities, configure your app to automatically request all necessary permissions from end users at runtime. 

## Android Manifest Permissions

The Ditto Android SDK includes a set of permissions that are required to use all
the device features necessary to enable sync. The permissions below will be
automatically merged into your app's final manifest.

:::CodeblockTabs
AndroidManifest.xml

```xml
<manifest
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:android="http://schemas.android.com/apk/res/android">

<uses-permission android:name="android.permission.BLUETOOTH"
    android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"
    android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_ADVERTISE"
    tools:targetApi="s" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT"
    tools:targetApi="s" />
<uses-permission android:name="android.permission.BLUETOOTH_SCAN"
    android:usesPermissionFlags="neverForLocation"
    tools:targetApi="s" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
    android:maxSdkVersion="32" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"
    android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.NEARBY_WIFI_DEVICES"
    android:usesPermissionFlags="neverForLocation"
    tools:targetApi="tiramisu" />
```
:::

The `tools:targetApi` attribute causes the permission to only be requested on
devices running the specified API level or higher. This avoids errors on older
OS versions that do not recognize the permission.

The `android:maxSdkVersion` attribute causes that permission to only be requested
on devices running the specified SDK level or lower. This avoids asking for more
permissions than Ditto needs, however it will prevent your app from being able
to request the permission on devices running a newer OS version. To opt out of
this behavior and request the permission on all OS versions, see the following
snippet:

:::CodeblockTabs
Location Permission Override

```xml
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"
    tools:remove="android:maxSdkVersion" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION"
    tools:remove="android:maxSdkVersion" />
```
:::

Note that you may need to add the `xmlns:tools="http://schemas.android.com/tools"`
namespace attribute to your app's root `<manifest>` tag as shown in the
`AndroidManifest.xml` example above.

This will configure your app's build to ignore the `android:maxSdkVersion`
attribute in our SDK allowing the permission to be requested on any SDK version.
This techniquie can be used to tweak any permissions to your liking.

For more details, see the documentation for the [Bluetooth ](https://developer.android.com/guide/topics/connectivity/bluetooth/permissions)and [WiFi Aware ](https://developer.android.com/guide/topics/connectivity/wifi-permissions)permissions in the Android Documentation.

## Runtime Permissions

Android requires certain permissions to be explicitly requested by the app to access features like Bluetooth Low Energy (LE) and Wi-Fi Aware. To comply, configure the manifest file for your app to request permissions from end users at runtime.&#x20;

To improve the user experience for your app, request all necessary permissions at once by calling the DittoSyncPermissions helper in your Activity or Fragment's `onCreate` method:

```java
void checkLocationPermission() {
   DittoSyncPermissions permissions = new DittoSyncPermissions(this);
   String[] missing = permissions.missingPermissions(permissions.requiredPermissions());
   if (missing.length > 0) {
      this.requestPermissions(missing, 0);
   }
}
```

On Android, after granting location access, Ditto may not immediately recognize the permission, causing a delay in syncing.&#x20;

To address this, whenever a relevant permission changes, call `refreshPermissions()` to quickly check and start syncing with the new permissions.

```java
@Override
public void onRequestPermissionsResult(int requestCode, String[] permissions, int[] grantResults) {
   super.onRequestPermissionsResult(requestCode, permissions, grantResults);
   this.ditto.refreshPermissions();
}
```

For more information about requesting permissions in a user-friendly way refer to Android's documentation: [Request App Permissions](https://developer.android.com/training/permissions/requesting).

# Integrating Ditto

:::::WorkflowBlock
:::WorkflowBlockItem
Add Ditto to your application.

We recommend placing this in your Application.onCreate method. Note that the `Context` you want to reference here is the **Application level** `Context`, rather than whatever Activity you might happen to be instantiating the Ditto instance from initially. This is because you need to ensure that your app is keeping a single Ditto instance alive for the entire lifetime of the application so it's not going out of scope or getting garbage collected.

```java
DittoDependencies androidDependencies = new DefaultAndroidDittoDependencies(this.context);
DittoLogger.setMinimumLogLevel(DittoLogLevel.DEBUG);
DittoIdentity identity = new DittoIdentity.OnlinePlayground(androidDependencies, "REPLACE_ME_WITH_YOUR_APP_ID", "YOUR_PLAYGROUND_TOKEN_HERE");
Ditto ditto = new Ditto(androidDependencies, identity);

try {
    ditto.startSync();
} catch(DittoError e) {
    //handle error
}
```
:::

::::WorkflowBlockItem
Replace `YOUR_APP_ID` and `YOUR_PLAYGROUND_TOKEN` with your access credentials available in the portal.

:::hint{type="info"}
For instructions on how to obtain your access credentials, see [Onboarding](docId\:JQjYL9gbvsgI9vlW3Ywvc). For an introduction to authentication in Ditto, see *Ditto Basics* > [Authentication and Initialization](docId\:c802C1qiAkfgA2QxmcyWu).
:::
::::
:::::