de.ipcon.db.module

Class KernelModule

java.lang.Object

de.ipcon.db.module.KernelModule

All Implemented Interfaces:

DatabaseConnectionProviderI, KernelDatabaseAccessorI, KernelDatabaseSaverI

Direct Known Subclasses:

ListeningKernelModule

public abstract class KernelModule
extends java.lang.Object
implements KernelDatabaseSaverI, DatabaseConnectionProviderI

Abstract base class that can be used when implementing "modules" or "services" that actually are more or less a part of the MyTISM server instance.

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log
static java.lang.String	STR_IF_POSSIBLE
static java.lang.String	STR_MANDATORY
static java.lang.String	STR_NEVER

Fields inherited from interface de.ipcon.db.core.KernelDatabaseSaverI

SAVE_RETRIES, SAVE_RETRY_DELAY_MS_MAX, SAVE_RETRY_DELAY_MS_MIN

Constructor Summary

Constructors

Constructor and Description
KernelModule(DBManLocalI _dbm) Constructor.
KernelModule(DBManLocalI _dbm, int _maxSaveRetries)

Method Summary

Modifier and Type	Method and Description
BOLoaderI	getBOLoader() Returns the BOLoaderI used by this KernelModule.
DBManConfigurationHelperI	getConfiguration() Convenience method for getting the DBMans DBManConfigurationHelperI.
java.sql.Connection	getConnection()
DBManLocalI	getDbm()
java.sql.Connection	getJDBCConnection() Returns a JDBC connection for direct access to the DBManLocalIs underlying database.
CachingBOLoader	getNewCachingBOLoader() Returns a newly built CachingBOLoader for usage in the context of this KernelModule.
java.lang.Long	getNodeNumber()
SchemaI	getSchema() Convenience method for getting the current SchemaI.
Benutzer	getUser()
boolean	isAuthoritativeSyncServer()
boolean	isShutdown()
BO	loadBO(java.lang.Long id) Loads the BO with the given ID.
BO	loadBO(java.lang.Long id, java.lang.Class<? extends BOI> clazz) Loads the BO with the given ID.
de.ipcon.db.core.QueryResultsI	query(java.lang.Class clazz)
de.ipcon.db.core.QueryResultsI	query(java.lang.Class clazz, java.lang.String where)
de.ipcon.db.core.QueryResultsI	query(java.lang.Class clazz, java.lang.String where, java.lang.Object[] pvals)
de.ipcon.db.core.QueryResultsI	query(java.lang.Class clazz, java.lang.String where, java.lang.Object[] pvals, boolean includeDeleted)
de.ipcon.db.core.QueryResultsI	query(java.lang.Class clazz, java.lang.String where, java.lang.Object[] pvals, boolean includeDeleted, java.lang.String orderBy)
de.ipcon.db.core.QueryResultsI	query(java.lang.String clazzname)
de.ipcon.db.core.QueryResultsI	query(java.lang.String clazzname, java.lang.String where)
de.ipcon.db.core.QueryResultsI	query(java.lang.String clazzname, java.lang.String where, java.lang.Object[] pvals)
de.ipcon.db.core.QueryResultsI	query(java.lang.String clazzname, java.lang.String where, java.lang.Object[] pvals, boolean includeDeleted)
de.ipcon.db.core.QueryResultsI	query(java.lang.String clazzname, java.lang.String where, java.lang.Object[] pvals, boolean includeDeleted, java.lang.String orderBy)
boolean	runsAsUser(Benutzer userToCheck) Returns true if this KernelModule acts as the passed user.
SaveResultI	save(Benutzer differingUser, java.lang.String desc, groovy.lang.Closure cl) Method to save a transaction which is handled by a closure in the parameter.
SaveResultI	save(Benutzer differingUser, java.lang.String desc, java.util.function.Consumer<Transaction> fn)
SaveResultI	save(Benutzer differingUser, java.lang.String desc, java.util.function.Function<Transaction,? extends java.lang.Object> fn)
SaveResultI	save(Benutzer differingUser, java.lang.String desc, ThrowingFunction<Transaction,? extends java.lang.Object,? extends java.lang.Throwable> fn)
SaveResultI	save(groovy.lang.Closure cl) Wrapper method to call save(String, Closure) without a description for the transaction.
SaveResultI	save(java.util.function.Consumer<Transaction> fn)
SaveResultI	save(java.util.function.Function<Transaction,? extends java.lang.Object> fn)
SaveResultI	save(java.lang.String desc, groovy.lang.Closure cl) Same as KernelDatabaseSaverI.save(Benutzer, String, Closure), but without a Benutzer.
SaveResultI	save(java.lang.String desc, java.util.function.Consumer<Transaction> fn)
SaveResultI	save(java.lang.String desc, java.util.function.Function<Transaction,? extends java.lang.Object> fn)
SaveResultI	save(java.lang.String desc, ThrowingFunction<Transaction,? extends java.lang.Object,? extends java.lang.Throwable> fn)
SaveResultI	save(ThrowingFunction<Transaction,? extends java.lang.Object,? extends java.lang.Throwable> fn)
void	setDbm(DBManLocalI $6)
void	setShutdown(boolean $8)
void	setUser(Benutzer $7)
void	shutdown(int shutdownWaitTimeoutInSecs) Shuts this module down in a clean fashion, normally called during server shutdown.

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.db.core.KernelDatabaseSaverI

handleSaveResultForRetry

Methods inherited from interface de.ipcon.db.core.DatabaseConnectionProviderI

wantsConnectionsClosed

Field Detail

log

public static final org.apache.log4j.Logger log

STR_NEVER

public static final java.lang.String STR_NEVER

See Also:

Constant Field Values

STR_IF_POSSIBLE

public static final java.lang.String STR_IF_POSSIBLE

See Also:

Constant Field Values

STR_MANDATORY

public static final java.lang.String STR_MANDATORY

See Also:

Constant Field Values

Constructor Detail

KernelModule

public KernelModule(DBManLocalI _dbm)

Constructor.

Parameters:

_dbm - the DBManLocalI instance to use within this KernelModule

KernelModule

public KernelModule(DBManLocalI _dbm,
                    int _maxSaveRetries)

Method Detail

runsAsUser

public boolean runsAsUser(Benutzer userToCheck)

Returns true if this KernelModule acts as the passed user.

getBOLoader

public BOLoaderI getBOLoader()

Returns the BOLoaderI used by this KernelModule.

getNewCachingBOLoader

public CachingBOLoader getNewCachingBOLoader()

Returns a newly built CachingBOLoader for usage in the context of this KernelModule.

shutdown

public void shutdown(int shutdownWaitTimeoutInSecs)

Shuts this module down in a clean fashion, normally called during server shutdown.

Parameters:

shutdownWaitTimeoutInSecs - time in seconds the DBMan will wait at most for this module to perform its shutdown

getConfiguration

public DBManConfigurationHelperI getConfiguration()

Convenience method for getting the DBMans DBManConfigurationHelperI.

Returns:

the DBManConfigurationHelperI of the DBManLocalI

getSchema

public SchemaI getSchema()

Description copied from interface: KernelDatabaseAccessorI

Convenience method for getting the current SchemaI.

Specified by:

getSchema in interface KernelDatabaseAccessorI

Returns:

the current SchemaI.

query

public de.ipcon.db.core.QueryResultsI query(java.lang.Class clazz)

query

public de.ipcon.db.core.QueryResultsI query(java.lang.Class clazz,
                                            java.lang.String where)

query

public de.ipcon.db.core.QueryResultsI query(java.lang.Class clazz,
                                            java.lang.String where,
                                            java.lang.Object[] pvals)

query

public de.ipcon.db.core.QueryResultsI query(java.lang.Class clazz,
                                            java.lang.String where,
                                            java.lang.Object[] pvals,
                                            boolean includeDeleted)

query

public de.ipcon.db.core.QueryResultsI query(java.lang.Class clazz,
                                            java.lang.String where,
                                            java.lang.Object[] pvals,
                                            boolean includeDeleted,
                                            java.lang.String orderBy)

query

public de.ipcon.db.core.QueryResultsI query(java.lang.String clazzname)

Specified by:

query in interface KernelDatabaseAccessorI

query

public de.ipcon.db.core.QueryResultsI query(java.lang.String clazzname,
                                            java.lang.String where)

Specified by:

query in interface KernelDatabaseAccessorI

query

public de.ipcon.db.core.QueryResultsI query(java.lang.String clazzname,
                                            java.lang.String where,
                                            java.lang.Object[] pvals)

Specified by:

query in interface KernelDatabaseAccessorI

query

public de.ipcon.db.core.QueryResultsI query(java.lang.String clazzname,
                                            java.lang.String where,
                                            java.lang.Object[] pvals,
                                            boolean includeDeleted)

Specified by:

query in interface KernelDatabaseAccessorI

query

public de.ipcon.db.core.QueryResultsI query(java.lang.String clazzname,
                                            java.lang.String where,
                                            java.lang.Object[] pvals,
                                            boolean includeDeleted,
                                            java.lang.String orderBy)

Specified by:

query in interface KernelDatabaseAccessorI

loadBO

public BO loadBO(java.lang.Long id)

Description copied from interface: KernelDatabaseAccessorI

Loads the BO with the given ID.

Specified by:

loadBO in interface KernelDatabaseAccessorI

Parameters:

id - the ID of the requested BO

Returns:

the BO with the given ID (or null if not found).

loadBO

public BO loadBO(java.lang.Long id,
                 java.lang.Class<? extends BOI> clazz)

Description copied from interface: KernelDatabaseAccessorI

Loads the BO with the given ID.

Specified by:

loadBO in interface KernelDatabaseAccessorI

Parameters:

id - the ID of the requested BO

clazz - the Class the requested BO is supposed to be of; can be null.

Returns:

the BO with the given ID (or null if not found).

getJDBCConnection

public java.sql.Connection getJDBCConnection()

Description copied from interface: KernelDatabaseAccessorI

Returns a JDBC connection for direct access to the DBManLocalIs underlying database.

Specified by:

getJDBCConnection in interface KernelDatabaseAccessorI

Returns:

a JDBC connection for direct access to the DBManLocalIs underlying database; null in case of an error

getConnection

public java.sql.Connection getConnection()

Specified by:

getConnection in interface DatabaseConnectionProviderI

isAuthoritativeSyncServer

public boolean isAuthoritativeSyncServer()

Specified by:

isAuthoritativeSyncServer in interface KernelDatabaseAccessorI

getNodeNumber

public java.lang.Long getNodeNumber()

Specified by:

getNodeNumber in interface KernelDatabaseAccessorI

save

public SaveResultI save(groovy.lang.Closure cl)

Description copied from interface: KernelDatabaseSaverI

Wrapper method to call save(String, Closure) without a description for the transaction.

Specified by:

save in interface KernelDatabaseSaverI

Parameters:

cl - Closure which manipulates the transaction

Returns:

Returns a SaveResult containing the resulting values of the save-procedure.

save

public SaveResultI save(java.lang.String desc,
                        groovy.lang.Closure cl)

Description copied from interface: KernelDatabaseSaverI

Same as KernelDatabaseSaverI.save(Benutzer, String, Closure), but without a Benutzer.

Specified by:

save in interface KernelDatabaseSaverI

Parameters:

desc - Description of the transaction

cl - Closure which manipulates the transaction

Returns:

Returns a SaveResult containing the resulting values of the save-procedure.

save

public SaveResultI save(Benutzer differingUser,
                        java.lang.String desc,
                        groovy.lang.Closure cl)

Description copied from interface: KernelDatabaseSaverI

Method to save a transaction which is handled by a closure in the parameter. Basically this method is used in the cauldron scripts such that we can define a closure manipulating a transaction. This transaction will then be saved by the ServerLocalTransactionI. Closure should: - have a single parameter for the transaction - return 1/true if it is finished correctly. If we should skip the save-procedure 1/false should be returned.

Specified by:

save in interface KernelDatabaseSaverI

Parameters:

differingUser - Benutzer object on whose behalf the transaction shall be saved

desc - Description of the transaction

cl - Closure which manipulates the transaction

Returns:

Returns a SaveResult containing the resulting values of the save-procedure.

save

public SaveResultI save(java.util.function.Consumer<Transaction> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(java.lang.String desc,
                        java.util.function.Consumer<Transaction> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(Benutzer differingUser,
                        java.lang.String desc,
                        java.util.function.Consumer<Transaction> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(java.util.function.Function<Transaction,? extends java.lang.Object> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(java.lang.String desc,
                        java.util.function.Function<Transaction,? extends java.lang.Object> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(Benutzer differingUser,
                        java.lang.String desc,
                        java.util.function.Function<Transaction,? extends java.lang.Object> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(ThrowingFunction<Transaction,? extends java.lang.Object,? extends java.lang.Throwable> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(java.lang.String desc,
                        ThrowingFunction<Transaction,? extends java.lang.Object,? extends java.lang.Throwable> fn)

Specified by:

save in interface KernelDatabaseSaverI

save

public SaveResultI save(Benutzer differingUser,
                        java.lang.String desc,
                        ThrowingFunction<Transaction,? extends java.lang.Object,? extends java.lang.Throwable> fn)

Specified by:

save in interface KernelDatabaseSaverI

getDbm

public DBManLocalI getDbm()

setDbm

public void setDbm(DBManLocalI $6)

getUser

public Benutzer getUser()

setUser

public void setUser(Benutzer $7)

isShutdown

public boolean isShutdown()

setShutdown

public void setShutdown(boolean $8)