AbstractMongoConnectionSourceSettings (GORM for MongoDB

org.grails.datastore.mapping.mongo.connections.AbstractMongoConnectionSourceSettings

All Implemented Interfaces and Traits:: MongoSettings

@groovy.transform.AutoClone
@groovy.transform.builder.Builder(builderStrategy = SimpleStrategy, prefix = '')
@groovy.transform.CompileStatic
abstract class AbstractMongoConnectionSourceSettings
extends ConnectionSourceSettings

Authors:: Graeme Rocher

Since:: 6.0

Field Summary

Fields
Modifiers	Name	Description
`protected com.mongodb.ConnectionString`	`connectionString`	The connection string

Properties Summary

Properties
Type	Name and description
`org.bson.codecs.configuration.CodecRegistry`	`codecRegistry` An additional codec registry
`java.util.List<java.lang.Class<? extends org.bson.codecs.Codec>>`	`codecs` Custom MongoDB codecs
`java.lang.String`	`connectionsCollection` The collection name to use to resolve connections when using MongoConnectionSources
`java.lang.String`	`databaseName` The default database name
`java.lang.String`	`engine` The engine to use by default
`java.lang.String`	`host` The host name to use
`java.lang.String`	`password` The password to use
`java.lang.Integer`	`port` The port to use
`boolean`	`stateless` Whether to use stateless mode by default
`java.lang.String`	`username` The username to use

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getDatabase()` @return Obtain the database name
	`com.mongodb.ConnectionString`	`getUrl()` @return Obtain the final URL whether from the connection string or the host/port setting
	`void`	`url(com.mongodb.ConnectionString connectionString)` @param connectionString The connection string

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ConnectionSourceSettings`	`getDefault, setDefault`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Field Detail
  - protected com.mongodb.ConnectionString connectionString
    
    The connection string
- Property Detail
  - org.bson.codecs.configuration.CodecRegistry codecRegistry
    
    An additional codec registry
  - java.util.List<java.lang.Class<? extends org.bson.codecs.Codec>> codecs
    
    Custom MongoDB codecs
  - java.lang.String connectionsCollection
    
    The collection name to use to resolve connections when using MongoConnectionSources
  - java.lang.String databaseName
    
    The default database name
  - java.lang.String engine
    
    The engine to use by default
  - java.lang.String host
    
    The host name to use
  - java.lang.String password
    
    The password to use
  - java.lang.Integer port
    
    The port to use
  - boolean stateless
    
    Whether to use stateless mode by default
  - java.lang.String username
    
    The username to use
- Method Detail
  - java.lang.String getDatabase()
    
    Returns:
    Obtain the database name
  - com.mongodb.ConnectionString getUrl()
    
    Returns:
    Obtain the final URL whether from the connection string or the host/port setting
  - void url(com.mongodb.ConnectionString connectionString)
    
    Parameters:
    connectionString - The connection string

Summary:
Field
Property
Method

| Detail:
Field
Property
Method

[Groovy] Class AbstractMongoConnectionSourceSettings

Field Summary

Properties Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected com.mongodb.ConnectionString connectionString

Property Detail

org.bson.codecs.configuration.CodecRegistry codecRegistry

java.util.List<java.lang.Class<? extends org.bson.codecs.Codec>> codecs

java.lang.String connectionsCollection

java.lang.String databaseName

java.lang.String engine

java.lang.String host

java.lang.String password

java.lang.Integer port

boolean stateless

java.lang.String username

Method Detail

java.lang.String getDatabase()

com.mongodb.ConnectionString getUrl()

void url(com.mongodb.ConnectionString connectionString)