net.sf.ehcache.hibernate.management.impl.EhcacheHibernateMBeanRegistration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ehcache Show documentation

Ehcache is an open source, standards-based cache used to boost performance, offload the database and simplify scalability. Ehcache is robust, proven and full-featured and this has made it the most widely-used Java-based cache.

There is a newer version: 2.10.9.2

Show newest version

/**
 *  Copyright Terracotta, Inc.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package net.sf.ehcache.hibernate.management.impl;

import java.util.Properties;

import net.sf.ehcache.CacheManager;

import org.hibernate.SessionFactory;

/**
 * Interface for helping registering mbeans for ehcache backed hibernate second-level cache
 * 
 * 
 * 
 * @author Abhishek Sanoujam
 * 
 */
public interface EhcacheHibernateMBeanRegistration {

    /**
     * Registers MBean for the input manager and session factory properties.
     * 
     * MBeans will be registered based on the input session factory name. If the input name is null or blank, the name of the cache-manager
     * is used
     * 
     * @param manager
     * @param properties
     * @throws Exception
     */
    public void registerMBeanForCacheManager(CacheManager manager, Properties properties) throws Exception;

    /**
     * Enable hibernate statistics in the mbean.
     * 
     * @param sessionFactory
     */
    public void enableHibernateStatisticsSupport(SessionFactory sessionFactory);

}