Class 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
    • Method Detail

      • 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