com.jalios.jcms.db
Class HibernateManager

java.lang.Object
  com.jalios.jcms.db.HibernateManager

All Implemented Interfaces:

JcmsConstants, JaliosConstants

public class HibernateManager
extends Object
implements JcmsConstants

This class is a singleton to manage Hibernate access.

Since:

jcms-6.0.0

Author:

Olivier Dedieu

Field Summary

static String

REVISION

Fields inherited from interface com.jalios.jcms.JcmsConstants

ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, ICON_ARCHIVE, ICON_LOCK, ICON_LOCK_STRONG, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_DEEP_COPY, OP_DEEP_DELETE, OP_DELETE, OP_MERGE, OP_UPDATE, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SESSION_AUTHORIZED_FILENAMES_SET, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, URL_REGEXP, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Fields inherited from interface com.jalios.util.JaliosConstants

CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEAR

Method Summary

void	addClass(Class<?> persistentClass) Adds a persistant class to the hibernate configuration.
void	addClass(String className) Adds a persistant class to the hibernate configuration.
void	addDBListener(DBListener listener) Adds a DBListener for all the classes.
void	addDBListener(DBListener listener, Class<?> clazz) Adds a DBListener for the given class.
void	addResource(String resourceName) Read Hibernate mappings as a application resourceName (i.e.
org.hibernate.SessionFactory	buildSessionFactory() Builds and returns the Hibernate SessionFactory.
void	checkConfiguration() Check if the configuration has been correctly set up with an access to hibernate.
CollectionMappingInfo	getCollectionMappingInfo(Class<?> clazz, String property) Returns the CollectionMappingInfo for the given collection property of the given class.
org.hibernate.cfg.Configuration	getConfiguration() Returns the Hibernate configuration.
String	getConnectionDataSource() Returns the connection datasource set in the Hibernate configuration.
String	getConnectionDriver() Returns the connection driver set in the Hibernate configuration.
String	getConnectionPassword() Returns the connection user's password set in the Hibernate configuration.
String	getConnectionPool() Returns the class name of the connection pool (if any).
String	getConnectionUrl() Returns the connection URL set in the Hibernate configuration.
String	getConnectionUsername() Returns the connection user set in the Hibernate configuration.
List<Class<? extends Publication>>	getDBPublicationClassList() Returns the list of Publication subclasses managed by Hibernate.
int	getDefaultMaxResults() Returns the default value for max-results paging parameter.
String	getDialect() Returns the dialect set in the Hibernate configuration.
static HibernateManager	getInstance()
Class<?>	getPersistentClass(String shortName) Returns the persistent class with the given short (i.e.
org.hibernate.SessionFactory	getSessionFactory() Returns the Hibernate SessionFactory.
boolean	isConnectionPoolEnabled()
boolean	isDataSourceConnection() Returns true if the connection is established with a DataSource declaration.
boolean	isJDBCConnection() Returns true if the connection is established with a JDBC declaration.
boolean	isQueryCacheEnabled()
boolean	isSecondLevelCacheEnabled()
void	removeDBListener(DBListener listener) Removes a DBListener for all the classes.
void	removeDBListener(DBListener listener, Class<?> clazz) Removes a DBListener for the given class.

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final String REVISION

See Also:

Constant Field Values

Method Detail

getInstance

public static HibernateManager getInstance()

getPersistentClass

public Class<?> getPersistentClass(String shortName)

Returns the persistent class with the given short (i.e. unqualified) name.

Parameters:

shortName - the class short name (eg WFNote for com.jalios.jcms.WFNote)

Returns:

the persistent class with the given short (i.e. unqualified) name.

Since:

jcms-6.0.0

getCollectionMappingInfo

public CollectionMappingInfo getCollectionMappingInfo(Class<?> clazz,
                                                      String property)

Returns the CollectionMappingInfo for the given collection property of the given class.

Parameters:

clazz - the persisted class

property - the name of the property

Returns:

the CollectionMappingInfo for the given collection property of the given class.

Since:

jcms-6.1.0

buildSessionFactory

public org.hibernate.SessionFactory buildSessionFactory()

Builds and returns the Hibernate SessionFactory.

Returns:

the Hibernate SessionFactory.

Since:

jcms-6.0.0

getSessionFactory

public org.hibernate.SessionFactory getSessionFactory()

Returns the Hibernate SessionFactory.

Returns:

the Hibernate SessionFactory

Since:

jcms-6.0.0

getConfiguration

public org.hibernate.cfg.Configuration getConfiguration()

Returns the Hibernate configuration.

Returns:

the Hibernate configuration.

Since:

jcms-6.0.0

addClass

public void addClass(Class<?> persistentClass)

Adds a persistant class to the hibernate configuration.

Parameters:

persistentClass - the class to be added

Since:

jcms-6.0.0

addClass

public void addClass(String className)

Adds a persistant class to the hibernate configuration.

Parameters:

className - the name of the class to be added

Since:

jcms-6.0.0

addResource

public void addResource(String resourceName)

Read Hibernate mappings as a application resourceName (i.e. classpath lookup) trying different classloaders.

Parameters:

resourceName - The resource name

Since:

jcms-6.0.0

checkConfiguration

public void checkConfiguration()
                        throws Exception

Check if the configuration has been correctly set up with an access to hibernate.

Throws:

Exception - if configuration in incorrect

Since:

jcms-6.0.0

getDialect

public String getDialect()

Returns the dialect set in the Hibernate configuration.

Returns:

the dialect set in the Hibernate configuration.

Since:

jcms-6.0.0

getConnectionUrl

public String getConnectionUrl()

Returns the connection URL set in the Hibernate configuration.

Returns:

the connection URL in the Hibernate configuration.

Since:

jcms-6.0.0

getConnectionUsername

public String getConnectionUsername()

Returns the connection user set in the Hibernate configuration.

Returns:

the connection user set in the Hibernate configuration.

Since:

jcms-6.0.0

getConnectionPassword

public String getConnectionPassword()

Returns the connection user's password set in the Hibernate configuration.

Returns:

the connection user's password set in the Hibernate configuration.

Since:

jcms-6.0.0

getConnectionDriver

public String getConnectionDriver()

Returns the connection driver set in the Hibernate configuration.

Returns:

the connection driver in the Hibernate configuration.

Since:

jcms-6.0.0

isJDBCConnection

public boolean isJDBCConnection()

Returns true if the connection is established with a JDBC declaration.

Returns:

true if the connection is established with a JDBC declaration.

Since:

jcms-7.0.0

isDataSourceConnection

public boolean isDataSourceConnection()

Returns true if the connection is established with a DataSource declaration.

Returns:

true if the connection is established with a DataSource declaration.

Since:

jcms-7.0.0

getConnectionDataSource

public String getConnectionDataSource()

Returns the connection datasource set in the Hibernate configuration.

Returns:

the connection datasource in the Hibernate configuration.

Since:

jcms-7.0.0

getConnectionPool

public String getConnectionPool()

Returns the class name of the connection pool (if any).

Returns:

the class name of the connection pool (if any).

Since:

jcms-7.0.0

isConnectionPoolEnabled

public boolean isConnectionPoolEnabled()

isSecondLevelCacheEnabled

public boolean isSecondLevelCacheEnabled()

isQueryCacheEnabled

public boolean isQueryCacheEnabled()

getDBPublicationClassList

public List<Class<? extends Publication>> getDBPublicationClassList()

Returns the list of Publication subclasses managed by Hibernate.

Returns:

the list of Publication subclasses managed by Hibernate.

Since:

jcms-6.0.0

getDefaultMaxResults

public int getDefaultMaxResults()

Returns the default value for max-results paging parameter. This default value can be defined with property "hibernate.query.default-max-results

Returns:

the default value for max-results paging parameter.

Since:

jcms-6.0.0

addDBListener

public void addDBListener(DBListener listener)

Adds a DBListener for all the classes.

Parameters:

listener - the listener

Since:

jcms-6.0.0

addDBListener

public void addDBListener(DBListener listener,
                          Class<?> clazz)

Adds a DBListener for the given class.

Parameters:

listener - the listener

clazz - the class

Since:

jcms-6.0.0

removeDBListener

public void removeDBListener(DBListener listener)

Removes a DBListener for all the classes.

Parameters:

listener - the listener

Since:

jcms-6.0.0

removeDBListener

public void removeDBListener(DBListener listener,
                             Class<?> clazz)

Removes a DBListener for the given class.

Parameters:

listener - the listener

clazz - the class

Since:

jcms-6.0.0