Module io.helidon.dbclient.mongodb

Package io.helidon.dbclient.mongodb

Class MongoDbClientProviderBuilder

java.lang.Object

io.helidon.dbclient.mongodb.MongoDbClientProviderBuilder

All Implemented Interfaces:

Builder<DbClient>, DbClientProviderBuilder<MongoDbClientProviderBuilder>, Supplier<DbClient>

public final class MongoDbClientProviderBuilder
extends Object
implements DbClientProviderBuilder<MongoDbClientProviderBuilder>

Builder for mongoDB database.

Method Summary

Modifier and Type	Method	Description
MongoDbClientProviderBuilder	addInterceptor(DbInterceptor interceptor)	Add an interceptor.
MongoDbClientProviderBuilder	addInterceptor(DbInterceptor interceptor, DbStatementType... dbStatementTypes)	Add an interceptor thas is active only on configured statement types.
MongoDbClientProviderBuilder	addInterceptor(DbInterceptor interceptor, String... statementNames)	Add an interceptor that is active only on the configured statement names.
<TYPE> MongoDbClientProviderBuilder	addMapper(DbMapper<TYPE> dbMapper, GenericType<TYPE> mappedType)	Add a custom mapper with generic types support.
<TYPE> MongoDbClientProviderBuilder	addMapper(DbMapper<TYPE> dbMapper, Class<TYPE> mappedClass)	Add a custom mapper.
MongoDbClientProviderBuilder	addMapperProvider(DbMapperProvider provider)	Database schema mappers provider.
DbClient	build()	Build database handler for specific provider.
MongoDbClientProviderBuilder	config(Config config)	Use database connection configuration from configuration file.
MongoDbClientProviderBuilder	credDb(String db)	Credential database.
MongoDbClientProviderBuilder	mapperManager(MapperManager manager)	Mapper manager for generic mapping, such as mapping of parameters to expected types.
MongoDbClientProviderBuilder	password(String password)	Set database connection p¨assword.
MongoDbClientProviderBuilder	statements(DbStatements statements)	Statements to use either from configuration or manually configured.
MongoDbClientProviderBuilder	url(String url)	Set database connection string (URL).
MongoDbClientProviderBuilder	username(String username)	Set database connection user name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get

Method Detail

build

public DbClient build()

Description copied from interface: DbClientProviderBuilder

Build database handler for specific provider.

Specified by:

build in interface Builder<DbClient>

Specified by:

build in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Returns:

database handler instance

config

public MongoDbClientProviderBuilder config(Config config)

Description copied from interface: DbClientProviderBuilder

Use database connection configuration from configuration file.

Specified by:

config in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

config - Config instance with database connection attributes

Returns:

database provider builder

url

public MongoDbClientProviderBuilder url(String url)

Description copied from interface: DbClientProviderBuilder

Set database connection string (URL).

Specified by:

url in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

url - database connection string

Returns:

database provider builder

username

public MongoDbClientProviderBuilder username(String username)

Description copied from interface: DbClientProviderBuilder

Set database connection user name.

Specified by:

username in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

username - database connection user name

Returns:

database provider builder

password

public MongoDbClientProviderBuilder password(String password)

Description copied from interface: DbClientProviderBuilder

Set database connection p¨assword.

Specified by:

password in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

password - database connection password

Returns:

database provider builder

credDb

public MongoDbClientProviderBuilder credDb(String db)

Credential database.

Parameters:

db - database name

Returns:

updated builder instance

statements

public MongoDbClientProviderBuilder statements(DbStatements statements)

Description copied from interface: DbClientProviderBuilder

Statements to use either from configuration or manually configured.

Specified by:

statements in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

statements - Statements to use

Returns:

updated builder instance

addInterceptor

public MongoDbClientProviderBuilder addInterceptor(DbInterceptor interceptor)

Description copied from interface: DbClientProviderBuilder

Add an interceptor. This allows to add implementation of tracing, metrics, logging etc. without the need to hard-code these into the base.

Specified by:

addInterceptor in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

interceptor - interceptor instance

Returns:

updated builder instance

addInterceptor

public MongoDbClientProviderBuilder addInterceptor(DbInterceptor interceptor,
                                                   String... statementNames)

Description copied from interface: DbClientProviderBuilder

Add an interceptor that is active only on the configured statement names. This interceptor is only executed on named statements.

Specified by:

addInterceptor in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

interceptor - interceptor instance

statementNames - statement names to be active on

Returns:

updated builder instance

addInterceptor

public MongoDbClientProviderBuilder addInterceptor(DbInterceptor interceptor,
                                                   DbStatementType... dbStatementTypes)

Description copied from interface: DbClientProviderBuilder

Add an interceptor thas is active only on configured statement types. This interceptor is executed on all statements of that type.

Note the specific handling of the following types:

• DbStatementType.DML - used only when the statement is created as a DML statement such as when using DbExecute.createDmlStatement(String) (this interceptor would not be enabled for inserts, updates, deletes)
• DbStatementType.UNKNOWN - used only when the statement is created as a general statement such as when using DbExecute.createStatement(String) (this interceptor would not be enabled for any other statements)

Specified by:

addInterceptor in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

interceptor - interceptor instance

dbStatementTypes - statement types to be active on

Returns:

updated builder instance

addMapper

public <TYPE> MongoDbClientProviderBuilder addMapper(DbMapper<TYPE> dbMapper,
                                                     Class<TYPE> mappedClass)

Description copied from interface: DbClientProviderBuilder

Add a custom mapper.

Specified by:

addMapper in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Type Parameters:

TYPE - type of the supported class

Parameters:

dbMapper - the mapper capable of mapping the mappedClass to various database objects

mappedClass - class that this mapper supports

Returns:

updated builder instance.

addMapper

public <TYPE> MongoDbClientProviderBuilder addMapper(DbMapper<TYPE> dbMapper,
                                                     GenericType<TYPE> mappedType)

Description copied from interface: DbClientProviderBuilder

Add a custom mapper with generic types support.

Specified by:

addMapper in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Type Parameters:

TYPE - type of the supported class

Parameters:

dbMapper - the mapper capable of mapping the mappedClass to various database objects

mappedType - type that this mapper supports

Returns:

updated builder instance.

mapperManager

public MongoDbClientProviderBuilder mapperManager(MapperManager manager)

Description copied from interface: DbClientProviderBuilder

Mapper manager for generic mapping, such as mapping of parameters to expected types.

Specified by:

mapperManager in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

manager - mapper manager

Returns:

updated builder instance

addMapperProvider

public MongoDbClientProviderBuilder addMapperProvider(DbMapperProvider provider)

Description copied from interface: DbClientProviderBuilder

Database schema mappers provider.

Specified by:

addMapperProvider in interface DbClientProviderBuilder<MongoDbClientProviderBuilder>

Parameters:

provider - database schema mappers provider to use

Returns:

updated builder instance