View Javadoc

1   /***
2    *  Copyright 2003-2010 Terracotta, Inc.
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.ehcache.management.provider;
17  
18  import net.sf.ehcache.CacheManager;
19  import net.sf.ehcache.terracotta.ClusteredInstanceFactory;
20  
21  /***
22   * Implementations of this interface will can initialize MBeanRegistration for
23   * the passed CacheManager.
24   * This is in addition to the ManagementService and has nothing to do
25   *
26   * <p />
27   *
28   * @author <a href="mailto:asanoujam@terracottatech.com">Abhishek Sanoujam</a>
29   * @since 1.7
30   */
31  public interface MBeanRegistrationProvider {
32  
33      /***
34       * Initialize MBeanRegistration if necessary for the cacheManager
35       *
36       * @param cacheManager
37       * @throws MBeanRegistrationProviderException
38       */
39      void initialize(CacheManager cacheManager, ClusteredInstanceFactory clusteredInstanceFactory)
40        throws MBeanRegistrationProviderException;
41  
42      /***
43       * Reinitialize the mbeans. Uses the current name of the {@link CacheManager} to re-register the mbeans
44       *
45       * @throws MBeanRegistrationProviderException
46       */
47      void reinitialize(ClusteredInstanceFactory clusteredInstanceFactory) throws MBeanRegistrationProviderException;
48  
49      /***
50       * Returns {@code true} if initialized otherwise false
51       * @return {@code true} if initialized
52       */
53      boolean isInitialized();
54  
55  }