com.lf.commons.db.sqlserver

Class SQLServerConnector

java.lang.Object

com.lf.commons.db.DatabaseConnector

com.lf.commons.db.sqlserver.SQLServerConnector

public class SQLServerConnector
extends DatabaseConnector

Configures and manages the Microsoft SQL Server database management system.

Since:

1.6

Version:

$Revision: 1.20 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DATABASE_DESCRIPTION The name of the represented database management system.
static java.lang.String	DATABASE_NAME The name of the represented database management system.
static java.lang.String	DRIVER_DISPLAY_NAME SQL driver display name (client/server mode).
static java.lang.String	DRIVER_NAME SQL driver class name (client/server mode).
static java.net.URL	ICON_SQLSERVER Default icon for the connector.

Fields inherited from class com.lf.commons.db.DatabaseConnector

cacheSchemaByTable, CONNECT_AUTH_REQUIRED, CONNECT_FAILED, CONNECT_SUCCESS, databaseDescription, databaseName, dbManager, defaultConn, defaultConnURL, driverDisplayName, driverName, driverProductName, driverProductVersion, params, pool, schemaMappings, typeConfig

Constructor Summary

Constructors

Constructor and Description
SQLServerConnector() Constructor method for i18n purposes only.
SQLServerConnector(java.util.Properties params, DatabaseManager manager) Constructor to create a connector instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkSequenceExists(java.lang.String schema, java.lang.String table) Checks whether a sequence for the given target table does exist.
int	connect(java.lang.String jdbcurl) Connects to the configured database.
static java.util.Properties	createParams(java.lang.String host, int port, java.lang.String dbname, java.lang.String username, java.lang.String password) Convenience method to preconfigure a connection.
boolean	createSequence(java.lang.String schema, java.lang.String table, int initval) Creates a new sequence for the given target table.
javax.swing.tree.TreeNode[]	createSubTree(java.lang.String[] jdbcurls) Creates a connector specific sub-tree from a set of JDBC URLs handled by the connector.
static DatabaseConnectorDef	getConnectorDef(boolean supported, boolean createconnections) Provides the connector definition to be listed without installing any connectors.
java.lang.String	getDefaultConnectionURL() Provides the JDBC URL for the default conenction (normally a user connection).
java.lang.String	getDisplayURL(java.lang.String jdbcurl) Makes sure that the given JDBC URL does not contain any passwords.
javax.swing.ImageIcon	getIcon() Provides the connector specific icon to represent it by GUI components.
java.sql.Connection	getNewConnectionNoCheck(java.lang.String jdbcurl) Creates a fresh connection for the given JDBC URL (never taken from the pool).
int	getSequenceCurrentValue(java.lang.String schema, java.lang.String table) Reads the current (last generated) value from a sequence.
int	getSequenceNextValue(java.lang.String schema, java.lang.String table) Reads the next value from a sequence.
java.lang.String	getUserConnectionURL() Creates a JDBC connection URL to access the database with user permissions.
java.lang.String	getUserName() Provides the name of the default user.
java.lang.String	getUserPassword() Provides the password for the default user.
static boolean	isAvailableStatic() Is the JDBC driver available on the classpath?
boolean	isConnected() Provides the info if this connector is currently connected to the database.
boolean	resetSequence(java.lang.String schema, java.lang.String table, int nextval) Resets an existing sequence for the given target table.

Methods inherited from class com.lf.commons.db.DatabaseConnector

addSchemaMapping, checkAndCreateSchemas, disconnect, finalize, getBytes, getBytes, getBytes, getBytes, getConnectionPool, getDatabaseDescription, getDatabaseManager, getDatabaseName, getDatabaseProductName, getDatabaseProductVersion, getDefaultConnection, getDefaultSchema, getDriver, getDriverDisplayName, getDriverName, getNewConnection, getParamDatabaseHost, getParamDatabaseName, getParamDatabasePort, getParams, getPooledConnection, getSchema, getSchemaMappings, getSchemaSeparator, getSerializedField, getTableFQN, getTypeTable, getUsedSchema, isAvailable, isBinary, isEmbedded, mapToJavaType, releasePooledConnection, replaceParams, replaceTableFQN, setParams, updateBytes, updateBytes, updateBytes, updateBytes, updateSchemaTables, updateSerializedField

Methods inherited from class java.lang.Object

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

Field Detail

DATABASE_NAME

public static final java.lang.String DATABASE_NAME

The name of the represented database management system.

See Also:

Constant Field Values

DATABASE_DESCRIPTION

public static final java.lang.String DATABASE_DESCRIPTION

The name of the represented database management system.

See Also:

Constant Field Values

DRIVER_NAME

public static final java.lang.String DRIVER_NAME

SQL driver class name (client/server mode).

See Also:

Constant Field Values

DRIVER_DISPLAY_NAME

public static final java.lang.String DRIVER_DISPLAY_NAME

SQL driver display name (client/server mode).

See Also:

Constant Field Values

ICON_SQLSERVER

public static final java.net.URL ICON_SQLSERVER

Default icon for the connector.

Constructor Detail

SQLServerConnector

public SQLServerConnector()
                   throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

SQLServerConnector

public SQLServerConnector(java.util.Properties params,
                  DatabaseManager manager)

Constructor to create a connector instance.

• PARAM_DB_HOST: required
• PARAM_DB_PORT: required
• PARAM_DB_NAME: required
• PARAM_DB_USER: required
• PARAM_DB_USER_PASSWORD: required

Parameters:

params - The database configuration

manager - The database manager

Since:

1.6

Method Detail

getDisplayURL

public java.lang.String getDisplayURL(java.lang.String jdbcurl)

Makes sure that the given JDBC URL does not contain any passwords.

Use this method if a JDBC URL shall be be displayed for the users of your application and if you do not like passwords being exposed.

Specified by:

getDisplayURL in class DatabaseConnector

Parameters:

jdbcurl - The original URL including passwords

Returns:

The JDBC URL without passwords

Throws:

java.lang.NullPointerException - If parameters are invalid

Since:

1.6

createSubTree

public javax.swing.tree.TreeNode[] createSubTree(java.lang.String[] jdbcurls)

Creates a connector specific sub-tree from a set of JDBC URLs handled by the connector.

Specified by:

createSubTree in class DatabaseConnector

Parameters:

jdbcurls - The JDBC URLs to be processed

Returns:

The array of tree nodes to be displayed

Throws:

java.lang.NullPointerException - If parameters are invalid

Since:

1.6

getUserConnectionURL

public java.lang.String getUserConnectionURL()

Creates a JDBC connection URL to access the database with user permissions.

Returns:

The JDBC URL

Since:

1.6

getNewConnectionNoCheck

public java.sql.Connection getNewConnectionNoCheck(java.lang.String jdbcurl)
                                            throws java.sql.SQLException

Creates a fresh connection for the given JDBC URL (never taken from the pool).

Here, no checking of the default connection is performed.

Parameters:

jdbcurl - The desired connector class in FQN

Returns:

The open connection, null if an error occurs

Throws:

java.sql.SQLException - If something goes wrong

Since:

1.6

connect

public int connect(java.lang.String jdbcurl)

Connects to the configured database.

Specified by:

connect in class DatabaseConnector

Parameters:

jdbcurl - The URL for the default connection

Returns:

CONNECT_SUCCESS | ...

Since:

1.6

isConnected

public boolean isConnected()

Provides the info if this connector is currently connected to the database.

The connection is present if the default connection is alive. If this method returns false then none of the connection types should be used any more. Some drivers like PostgreSQL do not support the isValid() method yet.

Overrides:

isConnected in class DatabaseConnector

Returns:

Currently connected?

Since:

1.6

getDefaultConnectionURL

public java.lang.String getDefaultConnectionURL()

Provides the JDBC URL for the default conenction (normally a user connection).

Typical JDBC URLs look like "jdbc:derby://localhost:1527/lima".

Specified by:

getDefaultConnectionURL in class DatabaseConnector

Returns:

The JDBC URL for the default connection, null if an error occurs

Since:

1.6

getUserName

public java.lang.String getUserName()

Provides the name of the default user.

Specified by:

getUserName in class DatabaseConnector

Returns:

The user name, may be empty, but never null

Since:

1.6

getUserPassword

public java.lang.String getUserPassword()

Provides the password for the default user.

Specified by:

getUserPassword in class DatabaseConnector

Returns:

The user password, may be empty, but never null

Since:

1.6

checkSequenceExists

public boolean checkSequenceExists(java.lang.String schema,
                          java.lang.String table)

Checks whether a sequence for the given target table does exist.

Specified by:

checkSequenceExists in class DatabaseConnector

Parameters:

schema - The target schema (optional)

table - The name of the target table

Returns:

Exists?

Since:

1.6

createSequence

public boolean createSequence(java.lang.String schema,
                     java.lang.String table,
                     int initval)

Creates a new sequence for the given target table.

Specified by:

createSequence in class DatabaseConnector

Parameters:

schema - The target schema (optional)

table - The name of the target table

initval - The initial value from sequence

Returns:

Successful?

Since:

1.6

getSequenceCurrentValue

public int getSequenceCurrentValue(java.lang.String schema,
                          java.lang.String table)

Reads the current (last generated) value from a sequence.

Specified by:

getSequenceCurrentValue in class DatabaseConnector

Parameters:

schema - The target schema (optional)

table - The name of the target table

Returns:

The current value, -1 otherwise

Since:

1.6

getSequenceNextValue

public int getSequenceNextValue(java.lang.String schema,
                       java.lang.String table)

Reads the next value from a sequence.

The Statement.getGeneratedKey() mechanism does only work for INSERTs issued with queryUpdate() (direct 'insert into ...' command which is not suitable). So we use a second sequence table with auto-increment column as long as Derby 10.6 is not released which will provide native sequence support. This mechanism should work with any other database with support for auto-increment columns (virtually all).

Table sequences follow the name schema "SEQ_[table]", so that the sequence for the table CRYPTO needs to be created as SEQ_CRYPTO. In addition to that, the sequence table needs to have another attribute for dummy INSERTS which need a VALUES clause to make Statement.getGeneratedKey() work :-( Sequence tables should have two attributes, the auto-increment (identity) column (use an arbitrary name here) and a second column DUMMY char(1) not null for the INSERTs.

Specified by:

getSequenceNextValue in class DatabaseConnector

Parameters:

schema - The target schema (optional)

table - The name of the target table

Returns:

The next value, -1 otherwise

Since:

1.6

resetSequence

public boolean resetSequence(java.lang.String schema,
                    java.lang.String table,
                    int nextval)

Resets an existing sequence for the given target table.

Specified by:

resetSequence in class DatabaseConnector

Parameters:

schema - The target schema (optional)

table - The name of the target table

nextval - The next value from sequence

Returns:

Successful?

Since:

1.6

getIcon

public javax.swing.ImageIcon getIcon()

Provides the connector specific icon to represent it by GUI components.

Variants of the provided image (24|32|48|128) should be made accessible to the GUIUtils.getIconVariant() method.

Specified by:

getIcon in class DatabaseConnector

Returns:

The connector icon 16 x 16 pixels

Since:

1.6

getConnectorDef

public static DatabaseConnectorDef getConnectorDef(boolean supported,
                                   boolean createconnections)

Provides the connector definition to be listed without installing any connectors.

Parameters:

supported - May the connector be used?

createconnections - May new connections be created?

Returns:

The connector definition

Since:

1.6

isAvailableStatic

public static boolean isAvailableStatic()

Is the JDBC driver available on the classpath?

Returns:

Driver available?

Since:

1.6

createParams

public static java.util.Properties createParams(java.lang.String host,
                                int port,
                                java.lang.String dbname,
                                java.lang.String username,
                                java.lang.String password)

Convenience method to preconfigure a connection.

Parameters:

host - The host

port - The port

dbname - The database name

username - The user

password - The password

Returns:

The database specific parameters