Last Updated: 7/22/2022, 2:54:48 AM

# Java SDK Getting Started Guide

# Overview

You can use the AccelByte Java SDK to implement our backend services within your game. The SDK acts as a bridge between your game and our services. Follow the tutorials below to learn how to set up our Java SDK.

# Prerequisites

Create a Game Namespace if you don’t have one yet. Be sure to keep the namespace’s Namespace ID as you will need it later.
Create an OAuth Client with a Confidential client type. Keep the Client ID and the Client Secret somewhere safe as you will be using them in this tutorial.
Download the AccelByte Java SDK (opens new window).

# Getting Started

# Installation

Add the required configuration in gradle.build. Replace {VERSION} with the specific release version tag from releases (opens new window) without the leading v character.

repositories {
   mavenCentral()
   maven {
      url 'https://nexus.accelbyte.net/repository/maven-releases/'
   }
}
dependencies {
   implementation 'net.accelbyte.sdk:sdk:{VERSION}'
}

TIP

Use the latest Java version that matches the backend version.

# Logging in as a Client using the SDK

Follow the steps below to log in as the client you have just created:

Create an http client instance called OkhttpClient.
Create a token repository instance called DefaultConfigRepository.
Create a config repository instance called DefaultTokenRepository.
Create a Server SDK instance called AccelByteSDK using the http client, token repository, and config repository instances you have just created.

Call the loginClient method of the AccelByteSDK Server SDK instance.

import net.accelbyte.sdk.core.AccelByteSDK;
import net.accelbyte.sdk.core.client.OkhttpClient;
import net.accelbyte.sdk.core.logging.OkhttpLogger;
import net.accelbyte.sdk.core.repository.DefaultConfigRepository;
import net.accelbyte.sdk.core.repository.DefaultTokenRepository;

…

OkhttpClient httpClient = new OkhttpClient();

DefaultTokenRepository tokenRepository = DefaultTokenRepository.getInstance();

DefaultConfigRepository configRepository = new DefaultConfigRepository();

AccelByteSDK sdk = new AccelByteSDK(

    httpClient,
    tokenRepository,
    configRepository
);

boolean login = sdk.loginClient();

if (!login) {
    // Login failed
}

TIP

DefaultTokenRepository provides the necessary values for AccelByteSDK from environment variables such as AB_BASE_URL, AB_CLIENT_ID, and AB_CLIENT_SECRET.

# Import AccelByte Services

You can now start using the following AccelByte services in your app.

# SDK Examples

See our Java SDK example repo (opens new window) for a selection of test cases you can use to customize your game.

IAM

Access

Analytics

Distribution

Engagement

Social

Monetization

Storage

Play