org.hibernate.cache.ehcache.management.impl.ProviderMBeanRegistrationHelper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-ehcache
Integration for Ehcache into Hibernate as a second-level caching service
There is a newer version: 6.0.0.Alpha7
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * Copyright (c) 2011, Red Hat Inc. or third-party contributors as
 * indicated by the @author tags or express copyright attribution
 * statements applied by the authors.  All third-party contributions are
 * distributed under license by Red Hat Inc.
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.hibernate.cache.ehcache.management.impl;

import java.lang.reflect.Field;
import java.util.Iterator;
import java.util.Map;
import java.util.Properties;
import java.util.TimerTask;
import java.util.concurrent.atomic.AtomicBoolean;

import net.sf.ehcache.CacheManager;
import org.jboss.logging.Logger;

import org.hibernate.SessionFactory;
import org.hibernate.cache.CacheException;
import org.hibernate.cache.ehcache.EhCacheMessageLogger;
import org.hibernate.cfg.Environment;
import org.hibernate.internal.SessionFactoryRegistry;

/**
 * Helper class for registering mbeans for ehcache backed hibernate second level cache
 * 
 * 
 *
 * @author Abhishek Sanoujam
 * @author Alex Snaps
 */
public class ProviderMBeanRegistrationHelper {
    private static final EhCacheMessageLogger LOG = Logger.getMessageLogger(
            EhCacheMessageLogger.class,
            ProviderMBeanRegistrationHelper.class.getName()
    );
    private static final int MILLIS_PER_SECOND = 1000;
    private static final int SLEEP_MILLIS = 500;

    private volatile EhcacheHibernateMBeanRegistrationImpl ehcacheHibernateMBeanRegistration;

    /**
     * Registers mbean for the input cache manager and the session factory name
     *
     * @param manager the backing cachemanager
     * @param properties session factory config properties
     */
    public void registerMBean(final CacheManager manager, final Properties properties) {
        if ( Boolean.getBoolean( "tc.active" ) ) {
            ehcacheHibernateMBeanRegistration = new EhcacheHibernateMBeanRegistrationImpl();
            manager.getTimer().scheduleAtFixedRate(
                    new RegisterMBeansTask( ehcacheHibernateMBeanRegistration, manager, properties ), SLEEP_MILLIS,
                    SLEEP_MILLIS
            );
        }
    }

    /**
     * Unregisters previously registered mbean.
     */
    public void unregisterMBean() {
        if ( ehcacheHibernateMBeanRegistration != null ) {
            ehcacheHibernateMBeanRegistration.dispose();
            ehcacheHibernateMBeanRegistration = null;
        }
    }

    /**
     * Task for running mbean registration that can be scheduled in a timer
     */
    private static class RegisterMBeansTask extends TimerTask {
        private static final int NUM_SECONDS = 30;
        private long startTime;
        private final AtomicBoolean mbeanRegistered = new AtomicBoolean( false );
        private final EhcacheHibernateMBeanRegistrationImpl ehcacheHibernateMBeanRegistration;
        private final CacheManager manager;
        private final Properties properties;

        public RegisterMBeansTask(EhcacheHibernateMBeanRegistrationImpl ehcacheHibernateMBeanRegistration,
                                  CacheManager manager, Properties properties) {
            this.ehcacheHibernateMBeanRegistration = ehcacheHibernateMBeanRegistration;
            this.manager = manager;
            this.properties = properties;
        }

        @Override
        public void run() {
            LOG.debug( "Running mbean initializer task for ehcache hibernate..." );
            startTime = System.currentTimeMillis();
            if ( mbeanRegistered.compareAndSet( false, true ) ) {
                try {
                    ehcacheHibernateMBeanRegistration.registerMBeanForCacheManager( manager, properties );
                    LOG.debug( "Successfully registered bean" );
                }
                catch ( Exception e ) {
                    throw new CacheException( e );
                }
            }
            SessionFactory sessionFactory = locateSessionFactory();
            if ( sessionFactory == null ) {
                LOG.debug(
                        "SessionFactory is probably still being initialized..."
                                + " waiting for it to complete before enabling hibernate statistics monitoring via JMX"
                );
                if ( System.currentTimeMillis() > startTime + ( NUM_SECONDS * MILLIS_PER_SECOND ) ) {
                    LOG.info( "Hibernate statistics monitoring through JMX is DISABLED." );
                    LOG.info(
                            "Failed to look up SessionFactory after " + NUM_SECONDS + " seconds using session-factory properties '"
                                    + properties + "'"
                    );
                    this.cancel();
                }
                return;
            }
            else {
                ehcacheHibernateMBeanRegistration.enableHibernateStatisticsSupport( sessionFactory );
                LOG.info( "Hibernate statistics monitoring through JMX is ENABLED. " );
                this.cancel();
            }
        }

        private SessionFactory locateSessionFactory() {
            String jndiName = properties.getProperty( Environment.SESSION_FACTORY_NAME );
            if ( jndiName != null ) {
                return SessionFactoryRegistry.INSTANCE.getNamedSessionFactory( jndiName );
            }
            try {
                Class factoryType = SessionFactoryRegistry.class;
                Field instancesField = getField( factoryType, "sessionFactoryMap" );
                if ( instancesField == null ) {
                    throw new RuntimeException( "Expected 'sessionFactoryMap' field on " + SessionFactoryRegistry.class.getName() );
                }
                instancesField.setAccessible( true );
                Map map = (Map) instancesField.get( null );
                if ( map == null ) {
                    return null;
                }
                Iterator values = map.values().iterator();
                while ( values.hasNext() ) {
                    SessionFactory sessionFactory = (SessionFactory) values.next();
                    Class sessionFactoryType = sessionFactory.getClass();
                    Field propertiesField = getField( sessionFactoryType, "properties" );
                    if ( propertiesField != null ) {
                        propertiesField.setAccessible( true );
                        Properties props = (Properties) propertiesField.get( sessionFactory );
                        if ( props != null && props.equals( properties ) ) {
                            return sessionFactory;
                        }
                    }
                }
            }
            catch ( RuntimeException re ) {
                LOG.error( "Error locating Hibernate Session Factory", re );
            }
            catch ( IllegalAccessException iae ) {
                LOG.error( "Error locating Hibernate Session Factory", iae );
            }
            return null;
        }
    }

    private static Field getField(Class c, String fieldName) {
        for ( Field field : c.getDeclaredFields() ) {
            if ( field.getName().equals( fieldName ) ) {
                return field;
            }
        }
        throw new NoSuchFieldError( "Type '" + c + "' has no field '" + fieldName + "'" );
    }
}