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

All Implemented Interfaces:

JcmsConstants, JaliosConstants
```
public class HibernateManager
extends java.lang.Object
implements JcmsConstants
```
This class is a singleton to manage Hibernate access.

Since:

jcms-6.0.0

Author:

Olivier Dedieu

Field Summary
- 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
- Fields inherited from interface com.jalios.jcms.JcmsConstants
  ADATE_SEARCH, ADMIN_NOTES_PROP, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_DIR, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, TEMPLATE_TAB, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XML

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addClass(java.lang.Class<?> persistentClass)`	Adds a persistant class to the hibernate configuration.
`void`	`addClass(java.lang.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, java.lang.Class<?> clazz)`	Adds a DBListener for the given class.
`void`	`addResource(java.lang.String resourceName)`	Read Hibernate mappings as a application resourceName (i.e.
`org.hibernate.SessionFactory`	`buildSessionFactory()`	Builds and returns the Hibernate SessionFactory.
`boolean`	`canBeSearchedInDB(java.lang.Class clazz)`	Returns true if the given class can be searched in DB.
`void`	`checkConfiguration()`	Check if the configuration has been correctly set up with an access to hibernate.
`CollectionMappingInfo`	`getCollectionMappingInfo(java.lang.Class<?> clazz, java.lang.String property)`	Returns the CollectionMappingInfo for the given collection property of the given class.
`org.hibernate.cfg.Configuration`	`getConfiguration()`	Returns the Hibernate configuration.
`java.lang.String`	`getConnectionDataSource()`	Returns the connection datasource set in the Hibernate configuration.
`java.lang.String`	`getConnectionDriver()`	Returns the connection driver set in the Hibernate configuration.
`java.lang.String`	`getConnectionPassword()`	Returns the connection user's password set in the Hibernate configuration.
`java.lang.String`	`getConnectionPool()`	Returns the class name of the connection pool (if any).
`java.lang.String`	`getConnectionUrl()`	Returns the connection URL set in the Hibernate configuration.
`java.lang.String`	`getConnectionUsername()`	Returns the connection user set in the Hibernate configuration.
`DatabaseInfo`	`getDatabaseInfo()`	Returns the database metadata.
`java.util.List<java.lang.Class<? extends Publication>>`	`getDBPublicationClassList()`	Returns the list of Publication subclasses managed by Hibernate.
`int`	`getDefaultMaxResults()`	Returns the default value for max-results paging parameter.
`java.lang.String`	`getDialect()`	Returns the dialect set in the Hibernate configuration.
`static HibernateManager`	`getInstance()`
`java.lang.Class<?>`	`getPersistentClass(java.lang.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, java.lang.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

- Method Detail
  - getInstance
```
public static HibernateManager getInstance()
```
  - getDatabaseInfo
```
public DatabaseInfo getDatabaseInfo()
```
    Returns the database metadata.
    
    Returns:
    
    the database metadata.
    
    Since:
    
    jcms-10.0.2
  - getPersistentClass
```
public java.lang.Class<?> getPersistentClass(java.lang.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(java.lang.Class<?> clazz,
                                                      java.lang.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(java.lang.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(java.lang.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(java.lang.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 java.lang.Exception
```
    Check if the configuration has been correctly set up with an access to hibernate.
    
    Throws:
    
    java.lang.Exception - if configuration in incorrect
    
    Since:
    
    jcms-6.0.0
  - getDialect
```
public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.util.List<java.lang.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
  - canBeSearchedInDB
```
public boolean canBeSearchedInDB(java.lang.Class clazz)
```
    Returns true if the given class can be searched in DB.
    
    Parameters:
    
    clazz - the class
    
    Returns:
    
    true if the given class can be searched in DB.
    
    Since:
    
    jcms-9.0.2
  - 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,
                          java.lang.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,
                             java.lang.Class<?> clazz)
```
    Removes a DBListener for the given class.
    
    Parameters:
    
    listener - the listener
    
    clazz - the class
    
    Since:
    
    jcms-6.0.0

Class HibernateManager

Field Summary

Fields inherited from interface com.jalios.util.JaliosConstants

Fields inherited from interface com.jalios.jcms.JcmsConstants

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getDatabaseInfo

getPersistentClass

getCollectionMappingInfo

buildSessionFactory

getSessionFactory

getConfiguration

addClass

addClass

addResource

checkConfiguration

getDialect

getConnectionUrl

getConnectionUsername

getConnectionPassword

getConnectionDriver

isJDBCConnection

isDataSourceConnection

getConnectionDataSource

getConnectionPool

isConnectionPoolEnabled

isSecondLevelCacheEnabled

isQueryCacheEnabled

getDBPublicationClassList

getDefaultMaxResults

canBeSearchedInDB

addDBListener

addDBListener

removeDBListener

removeDBListener