Docs Menu

Docs HomeRealm

Connect to an Atlas App Services backend - Java SDK

On this page

  • Initialize Realm
  • Access the App Client
  • Configuration

The App client is the interface for the App Services backend. It provides access to the authentication functionality, functions, and sync management.

Before you can use Realm in your app, you must initialize the Realm library. Your application should initialize Realm just once each time the application runs.

To initialize the Realm library, provide an Android context to the Realm.init() static function. You can provide an Activity, Fragment, or Application context for initialization with no difference in behavior. You can initialize the Realm library in the onCreate() method of an application subclass to ensure that you only initialize Realm once each time the application runs.

Tip

Register Your Application Subclass in the Android Manifest

If you create your own Application subclass, you must add it to your application's AndroidManifest.xml to execute your custom application logic. Set the android.name property of your manifest's application definition to ensure that Android instantiates your Application subclass before any other class when a user launches your application.

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.mongodb.example">
<application
android:name=".MyApplicationSubclass"
...
/>
</manifest>

Pass the App ID for your App, which you can find in the Realm UI.

Important

Initialize the App before Creating an Instance

You must initialize your App connection with Realm.init() before creating any instance of an App.

Note

You can create multiple App instances to connect to multiple Apps or to the same App with different configurations. All App instances that share the same App ID use the same underlying connection.

For more granular control of the details of your app connection, such as custom timeouts for connections, codecs used for MongoDB Data Access, and keys for local encryption, you can use the AppConfiguration Builder to control details of your App:

Note

For most use cases, you only need your application's App ID to connect to Realm. The other settings demonstrated here are optional.

←  Log Realm Events - Java SDKAuthenticate Users - Java SDK →
Share Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.