Get Started with the Java Driver

Overview

The Java driver is a synchronous API that you can use to interact with MongoDB from your Java application. This guide shows you how to create an application that uses the Java driver to connect to a MongoDB cluster hosted on MongoDB Atlas and query data in your cluster.

Follow this tutorial to connect a sample Java application to a MongoDB Atlas deployment. The tutorial includes the following sections:

• Download and Install: Learn how to install the Java driver.

• Create a MongoDB Deployment: Learn how to create a free MongoDB deployment on Atlas.

• Create a Connection String: Learn how to retrieve your Atlas deployment's connection string.

• Create a MongoClient: Learn how to create an application that connects to MongoDB and queries data stored in your deployment.

If you prefer to connect to MongoDB using a different driver or programming language, see our list of official drivers.

Download and Install

Complete the following steps to install the Java driver and its dependencies in your development environment.

<dependencies>
    <dependency>
        <groupId>org.mongodb</groupId>
        <artifactId>mongodb-driver-sync</artifactId>
        <version>5.4.0</version>
    </dependency>
</dependencies>

dependencies {
  implementation 'org.mongodb:mongodb-driver-sync:5.4.0'
}

After you complete these steps, you have a new project and the driver dependencies installed.

Create a MongoDB Deployment

You can create a free tier MongoDB deployment on MongoDB Atlas to store and manage your data. MongoDB Atlas hosts and manages your MongoDB database in the cloud.

After you complete these steps, you have a new free tier MongoDB deployment on Atlas, database user credentials, and sample data loaded in your database.

Create a Connection String

You can connect to your MongoDB deployment by providing a connection URI, also called a connection string, which instructs the driver on how to connect to a MongoDB deployment and how to behave while connected.

The connection string includes the hostname or IP address and port of your deployment, the authentication mechanism, user credentials when applicable, and connection options.

1

Find your MongoDB Atlas connection string

To retrieve your connection string for the deployment that you created in the previous step, log into your Atlas account and navigate to the Clusters section. Click the Connect button for your new deployment, as shown in the following screenshot:

Then, proceed to the Connect your application section. Select "Java" from the Driver selection menu and the version that best matches the version you installed from the Version selection menu.

2

Copy your connection string

Click the button on the right of the connection string to copy it to your clipboard, as shown in the following screenshot:

3

Edit your connection string placeholders

Paste your connection string into a file in your preferred text editor and save this file to a safe location for later use. In your connection string, replace the <db_username> and <db_password> placeholders with your database user's username and password.

After completing these steps, you have a connection string that contains your database username and password.

Run a Sample Query

After retrieving the connection string for your MongoDB Atlas deployment, you can connect to the deployment from your Java application and query the Atlas sample datasets.

import static com.mongodb.client.model.Filters.eq;
import org.bson.Document;
import com.mongodb.client.MongoClient;
import com.mongodb.client.MongoClients;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoDatabase;
public class QuickStart {
    public static void main( String[] args ) {
        // Replace the placeholder with your MongoDB deployment's connection string
        String uri = "<connection string uri>";
        try (MongoClient mongoClient = MongoClients.create(uri)) {
            MongoDatabase database = mongoClient.getDatabase("sample_mflix");
            MongoCollection<Document> collection = database.getCollection("movies");
            Document doc = collection.find(eq("title", "Back to the Future")).first();
            if (doc != null) {
                System.out.println(doc.toJson());
            } else {
                System.out.println("No matching documents found.");
            }
        }
    }
}

{
  _id: ...,
  plot: 'A young man is accidentally sent 30 years into the past...',
  genres: [ 'Adventure', 'Comedy', 'Sci-Fi' ],
  ...
  title: 'Back to the Future',
  ...
}

javax.net.ssl.SSLHandshakeException: extension (5) should not be presented in certificate_request

After you complete these steps, you have a Java application that connects to your MongoDB deployment, runs a query on the sample data, and returns a matching document.

Next Steps

Congratulations on completing the tutorial!

In this tutorial, you created a Java driver application that connects to a MongoDB deployment hosted on MongoDB Atlas and retrieves a document that matches a query.

You can continue to develop your sample application by visiting the following guides:

• Databases and Collections: Learn more about interacting with MongoDB databases and collections.

• Third-Party Integrations: Learn about the third-party integrations that you can use with the Java driver.