net.kut3.data

Class DbClientBuilder

java.lang.Object

net.kut3.data.DbClientBuilder

public class DbClientBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
String	authDbName()
DbClientBuilder	authDbName(String value)
boolean	autoCommit() Default true
DbClientBuilder	autoCommit(boolean autoCommit)
DbClient	build()
int	connectionTimeout() Default value is 5000ms.
DbClientBuilder	connectionTimeout(int connectionTimeout)
boolean	enableConnectionsPool() Default true.
DbClientBuilder	enableConnectionsPool(boolean enableConnectionsPool)
boolean	isReused() Default true.
DbClientBuilder	isReused(boolean isReused)
String	name()
DbClientBuilder	name(String name)
char[]	pwd()
DbClientBuilder	pwd(char[] pwd)
String	toString()
String	url()
DbClientBuilder	url(String url)
String	user()
DbClientBuilder	user(String user)
boolean	useSSL() Default value is false
DbClientBuilder	useSSL(boolean value)

Methods inherited from class java.lang.Object

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

Method Detail

url

public String url()

Returns:

JDBC connection string of the data source

url

public DbClientBuilder url(String url)

Parameters:

url - The appropriate JDBC connection string of current database type

Returns:

The current DbClientBuilder instance

user

public String user()

Returns:

The user name is used to login to the database

user

public DbClientBuilder user(String user)

Parameters:

user - The user name is used to login to the database

Returns:

The current DbClientBuilder instance

pwd

public char[] pwd()

Returns:

The password is used to login to the database

pwd

public DbClientBuilder pwd(char[] pwd)

Parameters:

pwd - The password is used to login to the database

Returns:

The current DbClientBuilder instance

connectionTimeout

public int connectionTimeout()

Default value is 5000ms.

Returns:

Number of miliseconds wait to connect before a connection timeout exception is thrown.

connectionTimeout

public DbClientBuilder connectionTimeout(int connectionTimeout)

Parameters:

connectionTimeout - Number of miliseconds wait to connect before a connection timeout exception is thrown. Default value is 5000.

Returns:

The current DbClientBuilder instance

autoCommit

public boolean autoCommit()

Default true

Returns:

true or false

autoCommit

public DbClientBuilder autoCommit(boolean autoCommit)

Parameters:

autoCommit - true or false

Returns:

The current DbClientBuilder instance

name

public String name()

Returns:

Name of the data source

name

public DbClientBuilder name(String name)

Parameters:

name - Name of the data source

Returns:

The current DbClientBuilder instance

enableConnectionsPool

public boolean enableConnectionsPool()

Default true.

Returns:

true if the constructed data source will use connections pool if any otherwise false

enableConnectionsPool

public DbClientBuilder enableConnectionsPool(boolean enableConnectionsPool)

Parameters:

enableConnectionsPool - Default value is true.

Returns:

The current DbClientBuilder instance

isReused

public boolean isReused()

Default true.

Returns:

true if the constructed data source will be reused otherwise false. Whenever a data source is marked as reused, you can use DbClientManager.getByName(String) to get it.

isReused

public DbClientBuilder isReused(boolean isReused)

Parameters:

isReused - Indicate the constructed data source should be reused or not. In case of true, the constructed data source will be registered to the data sources manager. Default value is true.

Returns:

The current DbClientBuilder instance

authDbName

public String authDbName()

Returns:

Name of the database used to authenticate the user

authDbName

public DbClientBuilder authDbName(String value)

Parameters:

value - Name of the database used to authenticate the user

Returns:

The current DbClientBuilder instance

useSSL

public boolean useSSL()

Default value is false

Returns:

true or false

useSSL

public DbClientBuilder useSSL(boolean value)

Parameters:

value - Indicates the connection between client and server uses SSL or not

Returns:

The current DbClientBuilder instance

build

public DbClient build()
               throws InitializationException

Returns:

A DbClient instance or null in case of error(s) occurred

Throws:

InitializationException - In case of error occurred, an InitializationException is thrown.

IllegalArgumentException - In case of missing name property or already exists

toString

public String toString()

Overrides:

toString in class Object