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
implements MongoSettings

Authors:: Graeme Rocher

Since:: 6.0

Field Summary

Fields
Modifiers	Name	Description
`protected ConnectionString`	`connectionString`	The connection string

Properties Summary

Properties
Type	Name and description
`CodecRegistry`	`codecRegistry` An additional codec registry
`java.util.List<java.lang.Class<? extends 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
`boolean`	`decimalType` Whether to use the decimal128 type for BigDecimal values
`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

Constructor Summary

Constructors
Constructor and description
`AbstractMongoConnectionSourceSettings ()`

Methods Summary

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

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class ConnectionSourceSettings`	`getDefault, setDefault`

- Field Detail
  - protected ConnectionString connectionString
    
    The connection string
- Property Detail
  - CodecRegistry codecRegistry
    
    An additional codec registry
  - java.util.List<java.lang.Class<? extends 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
  - boolean decimalType
    
    Whether to use the decimal128 type for BigDecimal values
    See Also:
    org.bson.types.Decimal128
  - 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
- Constructor Detail
  - AbstractMongoConnectionSourceSettings()
- Method Detail
  - java.lang.String getDatabase()
    
    Returns:
    Obtain the database name
  - ConnectionString getUrl()
    
    Returns:
    Obtain the final URL whether from the connection string or the host/port setting
  - void url(ConnectionString connectionString)
    
    Parameters:
    connectionString - The connection string

Summary:
Field
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractMongoConnectionSourceSettings

Field Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

protected ConnectionString connectionString

Property Detail

CodecRegistry codecRegistry

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

java.lang.String connectionsCollection

java.lang.String databaseName

boolean decimalType

java.lang.String engine

java.lang.String host

java.lang.String password

java.lang.Integer port

boolean stateless

java.lang.String username

Constructor Detail

AbstractMongoConnectionSourceSettings()

Method Detail

java.lang.String getDatabase()

ConnectionString getUrl()

void url(ConnectionString connectionString)