de.esprit.netsuite.server.db

Class DatabaseManager

java.lang.Object

de.esprit.common.util.DumpableObject

de.esprit.appsuite.launch.AbstractApplicationObject<S>

de.esprit.netsuite.server.AbstractServerObject<S>

de.esprit.netsuite.server.AbstractInitializableServerObject<ServerContext>

de.esprit.netsuite.server.db.DatabaseManager

All Implemented Interfaces:

ApplicationObject<ServerContext>, CloseableComponent, Initializable, SimpleLogSupport, Dumpable, PermissionControlled, ServerObject<ServerContext>, java.lang.AutoCloseable

public class DatabaseManager
extends AbstractInitializableServerObject<ServerContext>
implements CloseableComponent, PermissionControlled

This class maintains a pool of connected DataSource objects which can be selected by name. The selected DataSource is the current one that is used by DBObjects. Only one DataSource can be selected at a time.

Author:

Rainer Buesch

Constructor Summary

Constructors

Constructor and Description
DatabaseManager(ServerContext serverCtx)

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes and removes all DataSources in the pool
boolean	close(java.lang.String dataSourceName) Closes and removes the given DataSource by name
int	connect() Reads the srv_datasource.cfg file and fills the pool with according connected DataSource Objects.
DatabaseConnection	findDataSourceEntry(java.lang.String dsName) Finds the DatabaseConnection by name
java.sql.Connection	getCurrentConnection() Returns a connection of the currently selected connection pool.
DatabaseConnection	getCurrentDataSource()
DBConnectionPool	getDataSource(java.lang.String dataSourceName) Returns the corresponding DBConnectionPool or null if not found
DatabaseConnection[]	getDataSourceEntries() Returns the list of currently configured DataSourceEntries
DBConnectionPool[]	getDataSources()
java.util.List<ServerCredential>	getDefinedCredentials()
PermissionDefinition	getPermissionDefinition() Returns an object that identifies a PermissionControlled object with a unique name and provides a list of supported assignable permissions.
int	getSize() Returns the number of configured DataSources
boolean	hasDefinedCredentials()
void	init() Performs the initialization of this class.
ResourceLock	lockExclusive(SessionId sessId)
ResourceLock	lockShared(SessionId sessId)
void	releaseLock(SessionId sessId, ResourceLock lock)
DatabaseConnection	resetToDefaultDataSource(SessionId sessId) Resets to the default DataSource which is the first one configured in the config file.
DatabaseConnection	resetToPreviousDataSource(SessionId sessId) Resets to the previously selected DataSource.
DatabaseConnection	selectDataSource(SessionId sessId, java.lang.String dataSourceName) Selects the DataSource by name.

Methods inherited from class de.esprit.netsuite.server.AbstractInitializableServerObject

checkInitialized, isInitialized, setInitialized, toString

Methods inherited from class de.esprit.netsuite.server.AbstractServerObject

checkPermission, getServerConfig, getServerContext, getStatisticManager

Methods inherited from class de.esprit.appsuite.launch.AbstractApplicationObject

getApplicationContext, getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel

Methods inherited from class de.esprit.common.util.DumpableObject

configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toDumpString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseManager

public DatabaseManager(ServerContext serverCtx)

Method Detail

init

public void init()
          throws java.lang.Exception

Description copied from interface: Initializable

Performs the initialization of this class. Note that the implementation should maintain an isInitialized flag which must be set when initialization has completed.

Specified by:

init in interface Initializable

Throws:

java.lang.Exception

getPermissionDefinition

public PermissionDefinition getPermissionDefinition()

Description copied from interface: PermissionControlled

Returns an object that identifies a PermissionControlled object with a unique name and provides a list of supported assignable permissions.

Specified by:

getPermissionDefinition in interface PermissionControlled

getDefinedCredentials

public java.util.List<ServerCredential> getDefinedCredentials()

hasDefinedCredentials

public boolean hasDefinedCredentials()

findDataSourceEntry

public DatabaseConnection findDataSourceEntry(java.lang.String dsName)

Finds the DatabaseConnection by name

Returns:

the DatabaseConnection or null if not found

lockShared

public ResourceLock lockShared(SessionId sessId)
                        throws java.lang.Exception

Throws:

java.lang.Exception

lockExclusive

public ResourceLock lockExclusive(SessionId sessId)
                           throws java.lang.Exception

Throws:

java.lang.Exception

releaseLock

public void releaseLock(SessionId sessId,
               ResourceLock lock)
                 throws NotLockOwnerException

Throws:

NotLockOwnerException

connect

public int connect()
            throws java.lang.Exception

Reads the srv_datasource.cfg file and fills the pool with according connected DataSource Objects. The first configured DataSource becomes the current one.

Throws:

java.lang.Exception

getSize

public int getSize()

Returns the number of configured DataSources

close

public void close()

Closes and removes all DataSources in the pool

Specified by:

close in interface java.lang.AutoCloseable

close

public boolean close(java.lang.String dataSourceName)

Closes and removes the given DataSource by name

getDataSourceEntries

public DatabaseConnection[] getDataSourceEntries()

Returns the list of currently configured DataSourceEntries

getDataSources

public DBConnectionPool[] getDataSources()

getDataSource

public DBConnectionPool getDataSource(java.lang.String dataSourceName)
                               throws InvalidDataSourceException

Returns the corresponding DBConnectionPool or null if not found

Throws:

InvalidDataSourceException

selectDataSource

public DatabaseConnection selectDataSource(SessionId sessId,
                                  java.lang.String dataSourceName)
                                    throws InvalidDataSourceException,
                                           ResourceLockedException,
                                           PermissionException

Selects the DataSource by name. The sessionId may be null if the server itself calls this method.

Throws:

InvalidDataSourceException - if the data source name does not exist

ResourceLockedException

PermissionException

getCurrentDataSource

public DatabaseConnection getCurrentDataSource()

Returns:

the currently selected DatabaseConnection, null if none is configured

getCurrentConnection

public java.sql.Connection getCurrentConnection()

Returns a connection of the currently selected connection pool. Note that this connection MUST be returned to the pool after usage by calling its close() method.

Returns:

a SQL Connection , null if none is configured

resetToDefaultDataSource

public DatabaseConnection resetToDefaultDataSource(SessionId sessId)
                                            throws InvalidDataSourceException,
                                                   ResourceLockedException,
                                                   PermissionException

Resets to the default DataSource which is the first one configured in the config file.

Returns:

the selected default DatabaseConnection, null if none is configured

Throws:

InvalidDataSourceException

ResourceLockedException

PermissionException

resetToPreviousDataSource

public DatabaseConnection resetToPreviousDataSource(SessionId sessId)
                                             throws InvalidDataSourceException,
                                                    ResourceLockedException,
                                                    PermissionException

Resets to the previously selected DataSource. If the datasource selection never changed it is identical to the current datasource.

Returns:

the selected default DatabaseConnection, null if none is configured

Throws:

InvalidDataSourceException

ResourceLockedException

PermissionException