com.spacecode.sdk.network

Class DbConfiguration

java.lang.Object

com.spacecode.sdk.network.DbConfiguration

public class DbConfiguration
extends java.lang.Object

Describes a Database Configuration for Remote Devices.

Supported Database Management System are available as constant Strings.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MySQL
static java.lang.String	PostgreSQL
static java.lang.String	SQL_Server

Constructor Summary

Constructors

Constructor and Description
DbConfiguration(java.lang.String host, int port, java.lang.String name, java.lang.String user, java.lang.String password, java.lang.String dbms) Build a DbConfiguration which can be sent to/by the remote device to be configured.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDbms()
java.lang.String	getHost()
java.lang.String	getName()
java.lang.String	getPassword()
int	getPort()
java.lang.String	getUser()
void	setDbms(java.lang.String dbms) Update the type of Database Management System powering the database.
void	setHost(java.lang.String host) Update the IP address of the host.
void	setName(java.lang.String name) Update the name of the database used by the remote device.
void	setPassword(java.lang.String password) Update the password of the user allowed to read and write in the database.
void	setPort(int port) Update the TCP port the DBMS is listening to.
void	setUser(java.lang.String username) Update the name of the user allowed to read and write in the database.

Methods inherited from class java.lang.Object

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

Field Detail

MySQL

public static final java.lang.String MySQL

See Also:

Constant Field Values

PostgreSQL

public static final java.lang.String PostgreSQL

See Also:

Constant Field Values

SQL_Server

public static final java.lang.String SQL_Server

See Also:

Constant Field Values

Constructor Detail

DbConfiguration

public DbConfiguration(java.lang.String host,
               int port,
               java.lang.String name,
               java.lang.String user,
               java.lang.String password,
               java.lang.String dbms)

Build a DbConfiguration which can be sent to/by the remote device to be configured.

Parameters:

host - IP address of the server hosting the database management system.

port - TCP port number (by default, MySQL: 3306, PostgreSQL: 5432, SQL Server: 1433).

name - Database name.

user - Authorized (read and write) user's name.

password - Authorized (read and write) user's password. Can be null or blank.

dbms - Database Management System (see constants: MySQL, PostgreSQL or SQL_Server).

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

Method Detail

setHost

public void setHost(java.lang.String host)

Update the IP address of the host.

Parameters:

host - Server running the DBMS.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getHost

public java.lang.String getHost()

Returns:

IP address of the server running the DBMS.

setPort

public void setPort(int port)

Update the TCP port the DBMS is listening to.

Parameters:

port - Port used by the DBMS.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getPort

public int getPort()

Returns:

TCP port number used by the DBMS.

setName

public void setName(java.lang.String name)

Update the name of the database used by the remote device.

Parameters:

name - Name of the database to be used.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getName

public java.lang.String getName()

Returns:

Name of the database.

setUser

public void setUser(java.lang.String username)

Update the name of the user allowed to read and write in the database.

Parameters:

username - New username.

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getUser

public java.lang.String getUser()

Returns:

Name of the user allowed to read and write in the database.

setPassword

public void setPassword(java.lang.String password)

Update the password of the user allowed to read and write in the database.

Parameters:

password - New password (null is equivalent to empty).

getPassword

public java.lang.String getPassword()

Returns:

Password of the user allowed to read and write in the database.

setDbms

public void setDbms(java.lang.String dbms)

Update the type of Database Management System powering the database.

Parameters:

dbms - New DBMS (must be one of the available constant: MySQL, PostgreSQL or SQL_Server).

Throws:

java.lang.IllegalArgumentException - In case of invalid parameter.

getDbms

public java.lang.String getDbms()

Returns:

DBMS powering the database. Constant value: MySQL or PostgreSQL or SQL_Server.