org.activiti.engine.impl.db

Class DbSqlSession

java.lang.Object

org.activiti.engine.impl.db.DbSqlSession

All Implemented Interfaces:

Session

public class DbSqlSession
extends Object
implements Session

responsibilities: - delayed flushing of inserts updates and deletes - optional dirty checking - db specific statement name mapping

Author:

Tom Baeyens, Joram Barrez

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DbSqlSession.BulkCheckedDeleteOperation A bulk version of the DbSqlSession.CheckedDeleteOperation.
class	DbSqlSession.BulkDeleteOperation Use this DbSqlSession.DeleteOperation to execute a dedicated delete statement.
static class	DbSqlSession.CachedObject
class	DbSqlSession.CheckedDeleteOperation A DbSqlSession.DeleteOperation that checks for concurrent modifications if the persistent object implements HasRevision.
static interface	DbSqlSession.DeleteOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<Class<?>,Map<String,DbSqlSession.CachedObject>>	cachedObjects
protected String	connectionMetadataDefaultCatalog
protected String	connectionMetadataDefaultSchema
protected DbSqlSessionFactory	dbSqlSessionFactory
protected List<DbSqlSession.DeleteOperation>	deleteOperations
protected List<DeserializedObject>	deserializedObjects
protected List<PersistentObject>	insertedObjects
protected boolean	isOptimizeDeleteOperationsEnabled
static String[]	JDBC_METADATA_TABLE_TYPES
protected org.apache.ibatis.session.SqlSession	sqlSession

Constructor Summary

Constructors

Constructor and Description
DbSqlSession(DbSqlSessionFactory dbSqlSessionFactory)
DbSqlSession(DbSqlSessionFactory dbSqlSessionFactory, Connection connection, String catalog, String schema)

Method Summary

Methods

Modifier and Type	Method and Description
void	addDeserializedObject(DeserializedObject deserializedObject)
protected String	addMissingComponent(String missingComponents, String component)
protected String	addSqlStatementPiece(String sqlStatement, String line)
protected PersistentObject	cacheFilter(PersistentObject persistentObject) returns the object in the cache.
protected <T> T	cacheGet(Class<T> entityClass, String id)
protected DbSqlSession.CachedObject	cachePut(PersistentObject persistentObject, boolean storeState)
protected void	cacheRemove(Class<?> persistentObjectClass, String persistentObjectId)
void	close()
void	commit()
DeploymentQueryImpl	createDeploymentQuery()
ExecutionQueryImpl	createExecutionQuery()
GroupQueryImpl	createGroupQuery()
HistoricActivityInstanceQueryImpl	createHistoricActivityInstanceQuery()
HistoricDetailQueryImpl	createHistoricDetailQuery()
HistoricProcessInstanceQueryImpl	createHistoricProcessInstanceQuery()
HistoricTaskInstanceQueryImpl	createHistoricTaskInstanceQuery()
HistoricVariableInstanceQueryImpl	createHistoricVariableInstanceQuery()
JobQueryImpl	createJobQuery()
ModelQueryImpl	createModelQueryImpl()
ProcessDefinitionQueryImpl	createProcessDefinitionQuery()
ProcessInstanceQueryImpl	createProcessInstanceQuery()
TaskQueryImpl	createTaskQuery()
UserQueryImpl	createUserQuery()
protected static ActivitiVariableEvent	createVariableDeleteEvent(VariableInstanceEntity variableInstance)
void	dbSchemaCheckVersion()
void	dbSchemaCreate()
protected void	dbSchemaCreateEngine()
protected void	dbSchemaCreateHistory()
protected void	dbSchemaCreateIdentity()
void	dbSchemaDrop()
void	dbSchemaPrune()
String	dbSchemaUpdate()
protected void	dbSchemaUpgrade(String component, int currentDatabaseVersionsIndex)
void	delete(PersistentObject persistentObject)
void	delete(String statement, Object parameter)
protected void	dispatchEventsForRemovedOperations(List<DbSqlSession.DeleteOperation> removedOperations)
void	executeMandatorySchemaResource(String operation, String component)
void	executeSchemaResource(String operation, String component, String resourceName, boolean isOptional)
protected List	filterLoadedObjects(List<Object> loadedObjects)
<T> List<T>	findInCache(Class<T> entityClass)
<T> T	findInCache(Class<T> entityClass, String id)
void	flush()
protected void	flushDeletes(List<DbSqlSession.DeleteOperation> removedOperations)
protected void	flushDeserializedObjects()
protected void	flushInserts()
protected void	flushRegularDeletes(boolean dispatchEvent)
protected void	flushUpdates(List<PersistentObject> updatedObjects)
protected String	getCleanVersion(String versionString)
<T> T	getCustomMapper(Class<T> type)
DbSqlSessionFactory	getDbSqlSessionFactory()
protected String	getDbVersion()
String	getResourceForDbOperation(String directory, String operation, String component)
org.apache.ibatis.session.SqlSession	getSqlSession()
List<PersistentObject>	getUpdatedObjects()
void	insert(PersistentObject persistentObject)
boolean	isEngineTablePresent()
boolean	isHistoryTablePresent()
boolean	isIdentityTablePresent()
protected boolean	isMissingTablesException(Exception e)
boolean	isOptimizeDeleteOperationsEnabled()
protected boolean	isPersistentObjectDeleted(PersistentObject persistentObject)
boolean	isTablePresent(String tableName)
protected boolean	isUpgradeNeeded(String versionInDatabase)
protected List<DbSqlSession.DeleteOperation>	optimizeDeleteOperations(List<DbSqlSession.DeleteOperation> deleteOperations) Optimizes the given delete operations: for example, if there are two deletes for two different variables, merges this into one bulk delete which improves performance
void	performSchemaOperationsProcessEngineBuild()
void	performSchemaOperationsProcessEngineClose()
protected String	prependDatabaseTablePrefix(String tableName)
<T extends PersistentObject> List<T>	pruneDeletedEntities(List<T> listToPrune)
protected String	readNextTrimmedLine(BufferedReader reader)
protected List<DbSqlSession.DeleteOperation>	removeUnnecessaryOperations() Clears all deleted and inserted objects from the cache, and removes inserts and deletes that cancel each other.
void	rollback()
<T extends PersistentObject> T	selectById(Class<T> entityClass, String id)
List	selectList(String statement)
List	selectList(String statement, ListQueryParameterObject parameter)
List	selectList(String statement, ListQueryParameterObject parameter, Page page)
List	selectList(String statement, Object parameter)
List	selectList(String statement, Object parameter, int firstResult, int maxResults)
List	selectList(String statement, Object parameter, Page page)
List	selectListWithRawParameter(String statement, Object parameter, int firstResult, int maxResults)
List	selectListWithRawParameterWithoutFilter(String statement, Object parameter, int firstResult, int maxResults)
Object	selectOne(String statement, Object parameter)
void	setOptimizeDeleteOperationsEnabled(boolean isOptimizeDeleteOperationsEnabled)
void	touch(PersistentObject persistentObject)
void	update(PersistentObject persistentObject)
int	update(String statement, Object parameters)
protected String	updateDdlForMySqlVersionLowerThan56(String ddlStatements) MySQL is funny when it comes to timestamps and dates.

Methods inherited from class java.lang.Object

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

Field Detail

sqlSession

protected org.apache.ibatis.session.SqlSession sqlSession

dbSqlSessionFactory

protected DbSqlSessionFactory dbSqlSessionFactory

insertedObjects

protected List<PersistentObject> insertedObjects

cachedObjects

protected Map<Class<?>,Map<String,DbSqlSession.CachedObject>> cachedObjects

deleteOperations

protected List<DbSqlSession.DeleteOperation> deleteOperations

deserializedObjects

protected List<DeserializedObject> deserializedObjects

connectionMetadataDefaultCatalog

protected String connectionMetadataDefaultCatalog

connectionMetadataDefaultSchema

protected String connectionMetadataDefaultSchema

isOptimizeDeleteOperationsEnabled

protected boolean isOptimizeDeleteOperationsEnabled

JDBC_METADATA_TABLE_TYPES

public static String[] JDBC_METADATA_TABLE_TYPES

Constructor Detail

DbSqlSession

public DbSqlSession(DbSqlSessionFactory dbSqlSessionFactory)

DbSqlSession

public DbSqlSession(DbSqlSessionFactory dbSqlSessionFactory,
            Connection connection,
            String catalog,
            String schema)

Method Detail

touch

public void touch(PersistentObject persistentObject)

insert

public void insert(PersistentObject persistentObject)

update

public void update(PersistentObject persistentObject)

update

public int update(String statement,
         Object parameters)

delete

public void delete(String statement,
          Object parameter)

delete

public void delete(PersistentObject persistentObject)

selectList

public List selectList(String statement)

selectList

public List selectList(String statement,
              Object parameter)

selectList

public List selectList(String statement,
              Object parameter,
              Page page)

selectList

public List selectList(String statement,
              ListQueryParameterObject parameter,
              Page page)

selectList

public List selectList(String statement,
              Object parameter,
              int firstResult,
              int maxResults)

selectList

public List selectList(String statement,
              ListQueryParameterObject parameter)

selectListWithRawParameter

public List selectListWithRawParameter(String statement,
                              Object parameter,
                              int firstResult,
                              int maxResults)

selectListWithRawParameterWithoutFilter

public List selectListWithRawParameterWithoutFilter(String statement,
                                           Object parameter,
                                           int firstResult,
                                           int maxResults)

selectOne

public Object selectOne(String statement,
               Object parameter)

selectById

public <T extends PersistentObject> T selectById(Class<T> entityClass,
                                        String id)

filterLoadedObjects

protected List filterLoadedObjects(List<Object> loadedObjects)

cachePut

protected DbSqlSession.CachedObject cachePut(PersistentObject persistentObject,
                                 boolean storeState)

cacheFilter

protected PersistentObject cacheFilter(PersistentObject persistentObject)

returns the object in the cache. if this object was loaded before, then the original object is returned. if this is the first time this object is loaded, then the loadedObject is added to the cache.

cacheGet

protected <T> T cacheGet(Class<T> entityClass,
             String id)

cacheRemove

protected void cacheRemove(Class<?> persistentObjectClass,
               String persistentObjectId)

findInCache

public <T> List<T> findInCache(Class<T> entityClass)

findInCache

public <T> T findInCache(Class<T> entityClass,
                String id)

addDeserializedObject

public void addDeserializedObject(DeserializedObject deserializedObject)

flush

public void flush()

Specified by:

flush in interface Session

removeUnnecessaryOperations

protected List<DbSqlSession.DeleteOperation> removeUnnecessaryOperations()

Clears all deleted and inserted objects from the cache, and removes inserts and deletes that cancel each other.

optimizeDeleteOperations

protected List<DbSqlSession.DeleteOperation> optimizeDeleteOperations(List<DbSqlSession.DeleteOperation> deleteOperations)

Optimizes the given delete operations: for example, if there are two deletes for two different variables, merges this into one bulk delete which improves performance

flushDeserializedObjects

protected void flushDeserializedObjects()

getUpdatedObjects

public List<PersistentObject> getUpdatedObjects()

isPersistentObjectDeleted

protected boolean isPersistentObjectDeleted(PersistentObject persistentObject)

pruneDeletedEntities

public <T extends PersistentObject> List<T> pruneDeletedEntities(List<T> listToPrune)

flushInserts

protected void flushInserts()

flushUpdates

protected void flushUpdates(List<PersistentObject> updatedObjects)

flushDeletes

protected void flushDeletes(List<DbSqlSession.DeleteOperation> removedOperations)

dispatchEventsForRemovedOperations

protected void dispatchEventsForRemovedOperations(List<DbSqlSession.DeleteOperation> removedOperations)

createVariableDeleteEvent

protected static ActivitiVariableEvent createVariableDeleteEvent(VariableInstanceEntity variableInstance)

flushRegularDeletes

protected void flushRegularDeletes(boolean dispatchEvent)

close

public void close()

Specified by:

close in interface Session

commit

public void commit()

rollback

public void rollback()

dbSchemaCheckVersion

public void dbSchemaCheckVersion()

addMissingComponent

protected String addMissingComponent(String missingComponents,
                         String component)

getDbVersion

protected String getDbVersion()

dbSchemaCreate

public void dbSchemaCreate()

dbSchemaCreateIdentity

protected void dbSchemaCreateIdentity()

dbSchemaCreateHistory

protected void dbSchemaCreateHistory()

dbSchemaCreateEngine

protected void dbSchemaCreateEngine()

dbSchemaDrop

public void dbSchemaDrop()

dbSchemaPrune

public void dbSchemaPrune()

executeMandatorySchemaResource

public void executeMandatorySchemaResource(String operation,
                                  String component)

dbSchemaUpdate

public String dbSchemaUpdate()

isEngineTablePresent

public boolean isEngineTablePresent()

isHistoryTablePresent

public boolean isHistoryTablePresent()

isIdentityTablePresent

public boolean isIdentityTablePresent()

isTablePresent

public boolean isTablePresent(String tableName)

isUpgradeNeeded

protected boolean isUpgradeNeeded(String versionInDatabase)

getCleanVersion

protected String getCleanVersion(String versionString)

prependDatabaseTablePrefix

protected String prependDatabaseTablePrefix(String tableName)

dbSchemaUpgrade

protected void dbSchemaUpgrade(String component,
                   int currentDatabaseVersionsIndex)

getResourceForDbOperation

public String getResourceForDbOperation(String directory,
                               String operation,
                               String component)

executeSchemaResource

public void executeSchemaResource(String operation,
                         String component,
                         String resourceName,
                         boolean isOptional)

updateDdlForMySqlVersionLowerThan56

protected String updateDdlForMySqlVersionLowerThan56(String ddlStatements)

MySQL is funny when it comes to timestamps and dates. More specifically, for a DDL statement like 'MYCOLUMN timestamp(3)': - MySQL 5.6.4+ has support for timestamps/dates with millisecond (or smaller) precision. The DDL above works and the data in the table will have millisecond precision - MySQL < 5.5.3 allows the DDL statement, but ignores it. The DDL above works but the data won't have millisecond precision - MySQL 5.5.3 < [version] < 5.6.4 gives and exception when using the DDL above. Also, the 5.5 and 5.6 branches of MySQL are both actively developed and patched. Hence, when doing auto-upgrade/creation of the Activiti tables, the default MySQL DDL file is used and all timestamps/datetimes are converted to not use the millisecond precision by string replacement done in the method below. If using the DDL files directly (which is a sane choice in production env.), there is a distinction between MySQL version < 5.6.

addSqlStatementPiece

protected String addSqlStatementPiece(String sqlStatement,
                          String line)

readNextTrimmedLine

protected String readNextTrimmedLine(BufferedReader reader)
                              throws IOException

Throws:

IOException

isMissingTablesException

protected boolean isMissingTablesException(Exception e)

performSchemaOperationsProcessEngineBuild

public void performSchemaOperationsProcessEngineBuild()

performSchemaOperationsProcessEngineClose

public void performSchemaOperationsProcessEngineClose()

getCustomMapper

public <T> T getCustomMapper(Class<T> type)

createDeploymentQuery

public DeploymentQueryImpl createDeploymentQuery()

createModelQueryImpl

public ModelQueryImpl createModelQueryImpl()

createProcessDefinitionQuery

public ProcessDefinitionQueryImpl createProcessDefinitionQuery()

createProcessInstanceQuery

public ProcessInstanceQueryImpl createProcessInstanceQuery()

createExecutionQuery

public ExecutionQueryImpl createExecutionQuery()

createTaskQuery

public TaskQueryImpl createTaskQuery()

createJobQuery

public JobQueryImpl createJobQuery()

createHistoricProcessInstanceQuery

public HistoricProcessInstanceQueryImpl createHistoricProcessInstanceQuery()

createHistoricActivityInstanceQuery

public HistoricActivityInstanceQueryImpl createHistoricActivityInstanceQuery()

createHistoricTaskInstanceQuery

public HistoricTaskInstanceQueryImpl createHistoricTaskInstanceQuery()

createHistoricDetailQuery

public HistoricDetailQueryImpl createHistoricDetailQuery()

createHistoricVariableInstanceQuery

public HistoricVariableInstanceQueryImpl createHistoricVariableInstanceQuery()

createUserQuery

public UserQueryImpl createUserQuery()

createGroupQuery

public GroupQueryImpl createGroupQuery()

getSqlSession

public org.apache.ibatis.session.SqlSession getSqlSession()

getDbSqlSessionFactory

public DbSqlSessionFactory getDbSqlSessionFactory()

isOptimizeDeleteOperationsEnabled

public boolean isOptimizeDeleteOperationsEnabled()

setOptimizeDeleteOperationsEnabled

public void setOptimizeDeleteOperationsEnabled(boolean isOptimizeDeleteOperationsEnabled)