com.atlassian.confluence.upgrade.upgradetask

Class DataAccessUtils

java.lang.Object

com.atlassian.confluence.upgrade.upgradetask.DataAccessUtils

public final class DataAccessUtils
extends Object

Provides access to several underlying Hibernate and JDBC data access objects, which are commonly used in database-related upgrade tasks.

Since:

3.5

Method Summary

Modifier and Type	Method and Description
static Set<String>	filterToExistingTables(Set<String> tableNames, org.springframework.transaction.PlatformTransactionManager transactionManager, net.sf.hibernate.SessionFactory sessionFactory) Within a new transaction (for DB metadata retrieval), return the supplied Set of tables names filtered such that all the tables that don't exist are removed.
static Set<String>	filterToExistingTables(Set<String> tableNames, org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory)
static void	flush(net.sf.hibernate.Session session) Flushes the session.
static void	flushAndClear(net.sf.hibernate.Session session) Flushes and clears the session.
static Connection	getConnection(net.sf.hibernate.Session session) Returns the JDBC connection for the session.
static Connection	getConnection(org.hibernate.Session session)
static net.sf.hibernate.dialect.Dialect	getDialect()
static net.sf.hibernate.dialect.Dialect	getDialect(ConfluenceHibernateConfig hibernateConfig)
static org.hibernate.dialect.Dialect	getDialectV5() Deprecated. since 6.4.1. Use DataAccessUtils.getDialect() instead.
static org.hibernate.dialect.Dialect	getDialectV5(ConfluenceHibernateConfig hibernateConfig) Deprecated. since 6.4.1. Use DataAccessUtils.getDialect(ConfluenceHibernateConfig) instead.
static org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate(net.sf.hibernate.Session session) Returns a JDBC template for the provided Hibernate session.
static org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate(org.hibernate.Session session) Returns a JDBC template for the provided Hibernate session.
static org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate(net.sf.hibernate.SessionFactory sessionFactory) Returns a JDBC template for the active Hibernate session.
static org.springframework.jdbc.core.JdbcTemplate	getJdbcTemplate(org.hibernate.SessionFactory sessionFactory) Returns a JDBC template for the active Hibernate session.
static String	getPrimaryKeyColumnName(org.springframework.transaction.PlatformTransactionManager transactionManager, net.sf.hibernate.SessionFactory sessionFactory, String tableName) Locates the name of the column used as the primary key on the given table.
static String	getPrimaryKeyColumnName(org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory, String tableName) Locates the name of the column used as the primary key on the given table.
static org.hibernate.Session	getSession(org.hibernate.SessionFactory sessionFactory) Returns the current session or creates one if one does not exist.
static net.sf.hibernate.Session	getSession(net.sf.hibernate.SessionFactory sessionFactory) Returns the current session or creates one if one does not exist.
static boolean	isColumnPresent(String tableName, String columnName, org.springframework.transaction.PlatformTransactionManager transactionManager, net.sf.hibernate.SessionFactory sessionFactory, BootstrapManager bootstrapManager) Get whether a column is present in the database.
static boolean	isColumnPresent(String tableName, String columnName, org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory, BootstrapManager bootstrapManager) Get whether a column is present in the database.
static boolean	isTablePresent(String tableName, org.springframework.transaction.PlatformTransactionManager transactionManager, net.sf.hibernate.SessionFactory sessionFactory) Within a new transaction (for the database metadata lookup) check if the named table exists in the database.
static boolean	isTablePresent(String tableName, org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory)
static <T> T	runWithNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager, net.sf.hibernate.SessionFactory sessionFactory, Function<Connection,T> callback)
static <T> T	runWithNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory, Function<Connection,T> callback)
static <T> T	withNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager, net.sf.hibernate.SessionFactory sessionFactory, com.google.common.base.Function<Connection,T> callback) Deprecated. since 7.0.1. Use runWithNewConnection(PlatformTransactionManager, SessionFactory, Function)
static <T> T	withNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager, org.hibernate.SessionFactory sessionFactory, com.google.common.base.Function<Connection,T> callback) Deprecated. since 7.0.1. Use runWithNewConnection(PlatformTransactionManager, org.hibernate.SessionFactory, Function)

Methods inherited from class java.lang.Object

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

Method Detail

getSession

public static org.hibernate.Session getSession(org.hibernate.SessionFactory sessionFactory)

Returns the current session or creates one if one does not exist.

See Also:

SessionFactoryUtils.getSession(net.sf.hibernate.SessionFactory, boolean)

getSession

public static net.sf.hibernate.Session getSession(net.sf.hibernate.SessionFactory sessionFactory)

Returns the current session or creates one if one does not exist.

See Also:

SessionFactoryUtils.getSession(net.sf.hibernate.SessionFactory, boolean)

flush

public static void flush(net.sf.hibernate.Session session)
                  throws org.springframework.dao.DataAccessException

Flushes the session. That is, checks for any updates on attached Hibernate objects and issues the required SQL to the database server. All the objects attached to the session remain attached and in memory.

This does not commit anything by itself, but relies on the surrounding transaction to commit the changes.

Throws:

org.springframework.dao.DataAccessException - if the connection cannot be retrieved

flushAndClear

public static void flushAndClear(net.sf.hibernate.Session session)
                          throws org.springframework.dao.DataAccessException

Flushes and clears the session. That is, checks for any updates on attached Hibernate objects and issues the required SQL to the database server, then clears all the objects from the Hibernate session.

This does not commit anything by itself, but relies on the surrounding transaction to commit or roll back the changes.

Use this method if you are processing a large number of Hibernate objects and want to make sure that ones which are already processed are not kept in memory.

Throws:

org.springframework.dao.DataAccessException - if the connection cannot be retrieved

getJdbcTemplate

public static org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate(net.sf.hibernate.Session session)

Returns a JDBC template for the provided Hibernate session. The JDBC template participates in the same transaction as the session.

getJdbcTemplate

public static org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate(org.hibernate.Session session)

Returns a JDBC template for the provided Hibernate session. The JDBC template participates in the same transaction as the session.

getJdbcTemplate

public static org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate(net.sf.hibernate.SessionFactory sessionFactory)

Returns a JDBC template for the active Hibernate session. Creates a new session if one does not exist.

See Also:

getSession(SessionFactory), getJdbcTemplate(Session)

getJdbcTemplate

public static org.springframework.jdbc.core.JdbcTemplate getJdbcTemplate(org.hibernate.SessionFactory sessionFactory)

Returns a JDBC template for the active Hibernate session. Creates a new session if one does not exist.

See Also:

getJdbcTemplate(Session)

getConnection

public static Connection getConnection(net.sf.hibernate.Session session)
                                throws org.springframework.dao.DataAccessException

Returns the JDBC connection for the session. Statements created and executed on this connection will typically share the same transaction as the session.

Throws:

org.springframework.dao.DataAccessException - if the connection cannot be retrieved

getConnection

public static Connection getConnection(org.hibernate.Session session)

getDialect

public static net.sf.hibernate.dialect.Dialect getDialect()
                                                   throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException

getDialect

public static net.sf.hibernate.dialect.Dialect getDialect(ConfluenceHibernateConfig hibernateConfig)
                                                   throws org.springframework.dao.DataAccessException

Throws:

org.springframework.dao.DataAccessException

getDialectV5

@Deprecated
public static org.hibernate.dialect.Dialect getDialectV5()
                                                              throws org.springframework.dao.DataAccessException

Deprecated. since 6.4.1. Use DataAccessUtils.getDialect() instead.

Gets the Hibernate 5 Dialect corresponding to the current Hibernate configuration

Returns:

a Hibernate 5 Dialect

Throws:

org.springframework.dao.DataAccessException

getDialectV5

@Deprecated
public static org.hibernate.dialect.Dialect getDialectV5(ConfluenceHibernateConfig hibernateConfig)
                                                              throws org.springframework.dao.DataAccessException

Deprecated. since 6.4.1. Use DataAccessUtils.getDialect(ConfluenceHibernateConfig) instead.

Gets the Hibernate 5 Dialect corresponding to the provided Hibernate configuration

Parameters:

hibernateConfig -

Returns:

a Hibernate 5 Dialect

Throws:

org.springframework.dao.DataAccessException

filterToExistingTables

public static Set<String> filterToExistingTables(Set<String> tableNames,
                                                 org.springframework.transaction.PlatformTransactionManager transactionManager,
                                                 net.sf.hibernate.SessionFactory sessionFactory)

Within a new transaction (for DB metadata retrieval), return the supplied Set of tables names filtered such that all the tables that don't exist are removed.

Parameters:

tableNames -

transactionManager -

Returns:

a Set of table names which are found in the database.

filterToExistingTables

public static Set<String> filterToExistingTables(Set<String> tableNames,
                                                 org.springframework.transaction.PlatformTransactionManager transactionManager,
                                                 org.hibernate.SessionFactory sessionFactory)

isTablePresent

public static boolean isTablePresent(String tableName,
                                     org.springframework.transaction.PlatformTransactionManager transactionManager,
                                     net.sf.hibernate.SessionFactory sessionFactory)

Within a new transaction (for the database metadata lookup) check if the named table exists in the database.

Parameters:

tableName -

transactionManager -

sessionFactory -

Returns:

true if it exists, otherwise false.

isTablePresent

public static boolean isTablePresent(String tableName,
                                     org.springframework.transaction.PlatformTransactionManager transactionManager,
                                     org.hibernate.SessionFactory sessionFactory)

getPrimaryKeyColumnName

public static String getPrimaryKeyColumnName(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                             net.sf.hibernate.SessionFactory sessionFactory,
                                             String tableName)

Locates the name of the column used as the primary key on the given table.

Returns:

The name of the pri9mary key column

Throws:

IllegalStateException - if there is no primary key on the given table, or if the primary is constructed from more than one column

getPrimaryKeyColumnName

public static String getPrimaryKeyColumnName(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                             org.hibernate.SessionFactory sessionFactory,
                                             String tableName)

Locates the name of the column used as the primary key on the given table.

Returns:

The name of the pri9mary key column

Throws:

IllegalStateException - if there is no primary key on the given table, or if the primary is constructed from more than one column

Since:

6.2.0

isColumnPresent

public static boolean isColumnPresent(String tableName,
                                      String columnName,
                                      org.springframework.transaction.PlatformTransactionManager transactionManager,
                                      net.sf.hibernate.SessionFactory sessionFactory,
                                      BootstrapManager bootstrapManager)
                               throws com.atlassian.core.exception.InfrastructureException

Get whether a column is present in the database.

Throws:

com.atlassian.core.exception.InfrastructureException

isColumnPresent

public static boolean isColumnPresent(String tableName,
                                      String columnName,
                                      org.springframework.transaction.PlatformTransactionManager transactionManager,
                                      org.hibernate.SessionFactory sessionFactory,
                                      BootstrapManager bootstrapManager)
                               throws com.atlassian.core.exception.InfrastructureException

Get whether a column is present in the database.

Throws:

com.atlassian.core.exception.InfrastructureException

Since:

6.2.0

withNewConnection

@Deprecated
public static <T> T withNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                                  net.sf.hibernate.SessionFactory sessionFactory,
                                                  com.google.common.base.Function<Connection,T> callback)

Deprecated. since 7.0.1. Use runWithNewConnection(PlatformTransactionManager, SessionFactory, Function)

runWithNewConnection

public static <T> T runWithNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                         net.sf.hibernate.SessionFactory sessionFactory,
                                         Function<Connection,T> callback)

Since:

7.0.1

withNewConnection

@Deprecated
public static <T> T withNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                                  org.hibernate.SessionFactory sessionFactory,
                                                  com.google.common.base.Function<Connection,T> callback)

Deprecated. since 7.0.1. Use runWithNewConnection(PlatformTransactionManager, org.hibernate.SessionFactory, Function)

runWithNewConnection

public static <T> T runWithNewConnection(org.springframework.transaction.PlatformTransactionManager transactionManager,
                                         org.hibernate.SessionFactory sessionFactory,
                                         Function<Connection,T> callback)

Since:

7.0.1