com.mongodb.client

Class MongoDriverInformation

java.lang.Object

com.mongodb.client.MongoDriverInformation

public final class MongoDriverInformation
extends Object

The MongoDriverInformation class allows driver and library authors to add extra information about their library. This information is then available in the MongoD/MongoS logs.

The following metadata can be included when creating a MongoClient.

• The driver name. Eg: mongo-scala-driver
• The driver version. Eg: 1.2.0
• Extra platform information. Eg: Scala 2.11

Note: Library authors are responsible for accepting MongoDriverInformation from external libraries using their library. Also all the meta data is limited to 512 bytes and any excess data will be truncated.

Since:

3.4

Since server release

3.4

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MongoDriverInformation.Builder

Method Summary

Modifier and Type	Method and Description
static MongoDriverInformation.Builder	builder() Convenience method to create a Builder.
static MongoDriverInformation.Builder	builder(MongoDriverInformation mongoDriverInformation) Convenience method to create a Builder.
List<String>	getDriverNames() Returns the driverNames
List<String>	getDriverPlatforms() Returns the driverPlatforms
List<String>	getDriverVersions() Returns the driverVersions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static MongoDriverInformation.Builder builder()

Convenience method to create a Builder.

Returns:

a builder

builder

public static MongoDriverInformation.Builder builder(MongoDriverInformation mongoDriverInformation)

Convenience method to create a Builder.

Parameters:

mongoDriverInformation - the mongoDriverInformation to extend

Returns:

a builder

getDriverNames

public List<String> getDriverNames()

Returns the driverNames

Returns:

the driverNames

getDriverVersions

public List<String> getDriverVersions()

Returns the driverVersions

Returns:

the driverVersions

getDriverPlatforms

public List<String> getDriverPlatforms()

Returns the driverPlatforms

Returns:

the driverPlatforms