[jboss-cvs] JBossCache/src-50/org/jboss/cache/pojo/jmx ...

[Brian Stansberry]

  User: bstansberry
  Date: 06/11/09 21:24:34

  Modified:    src-50/org/jboss/cache/pojo/jmx 
                        PojoCacheJmxWrapperMBean.java
  Log:
  Clean up what methods need to be in MBean interface
  
  Revision  Changes    Path
  1.2       +30 -29    JBossCache/src-50/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: PojoCacheJmxWrapperMBean.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src-50/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -b -r1.1 -r1.2
  --- PojoCacheJmxWrapperMBean.java	6 Nov 2006 05:01:42 -0000	1.1
  +++ PojoCacheJmxWrapperMBean.java	10 Nov 2006 02:24:34 -0000	1.2
  @@ -21,8 +21,7 @@
    */
   package org.jboss.cache.pojo.jmx;
   
  -import javax.management.MalformedObjectNameException;
  -
  +import org.jboss.cache.Cache;
   import org.jboss.cache.config.Configuration;
   import org.jboss.cache.jmx.LifeCycle;
   import org.jboss.cache.pojo.PojoCache;
  @@ -31,12 +30,11 @@
    * StandardMBean interface for {@link PojoCacheJmxWrapperMBean}.
    * 
    * @author <a href="brian.stansberry at jboss.com">Brian Stansberry</a>
  - * @version $Revision: 1.1 $
  + * @version $Revision: 1.2 $
    */
   public interface PojoCacheJmxWrapperMBean 
      extends PojoCacheMBean
   {
  -   
      /**
       * Get the PojoCache.
       * 
  @@ -44,43 +42,46 @@
       */
      public PojoCache getPojoCache();
      
  -   public String getPojoCacheObjectName();
  -   
  -   public void setPojoCacheObjectName(String name) throws MalformedObjectNameException;
  +   /**
  +    * Retrieves an immutable configuration.
  +    */
  +   Configuration getConfiguration();
      
      /**
  -    * Ensures the underlying cache is initialized and that needed JMX registrations
  -    * are done, and then calls {@link org.jboss.cache.Cache#create() create()} on the
  -    * underlying cache.
  +    * Gets whether this object should register the underlying {@link Cache}
  +    * with JMX during {@link LifeCycle#create() create()}.
       * <p/>
  -    * If the underlying cache has not been instantiated, instantiates it.  Then,
  -    * if an MBeanServer has been passed to {@link #setMbeanServer(MBeanServer)},
  -    * this object registers itself with that server.  Then, if an MBeanServer is
  -    * available (either through <code>setMbeanServer</code> or 
  -    * {@link #preRegister(MBeanServer, ObjectName)}) and property 
  -    * <code>registerInterceptors</code> is <code>true</code>, registers the 
  -    * cache's interceptors with JMX.
  +    * Default is <code>false</code>.
       */
  -   void create() throws Exception;
  +   boolean getRegisterPlainCache();
      
      /**
  -    * Sets the configuration that the underlying cache should use.
  -    * 
  -    * @param config the configuration
  -    * 
  -    * @throws IllegalArgumentException if <code>config</code> is <code>null</code>.
  +    * Sets whether this object should register the underlying {@link Cache}
  +    * with JMX during {@link LifeCycle#create() create()}.
  +    * <p/>
  +    * Default is <code>false</code>.
       */
  -   void setConfiguration(Configuration config);
  +   public void setRegisterPlainCache(boolean registerPlainCache);
      
      /**
       * Gets whether this object should register the cache's interceptors
  -    * with JMX during {@link LifeCycle#create() create()}.
  +    * with JMX.
  +    * <p/>
  +    * This property is only relevant if {@link #setRegisterPlainCache(boolean) registerPlainCache}
  +    * is <code>true</code>.
  +    * <p/>
  +    * Default is <code>true</code>.
       */
      boolean getRegisterInterceptors();
      
      /**
       * Sets whether this object should register the cache's interceptors
  -    * with JMX during {@link LifeCycle#create() create()}.
  +    * with JMX.
  +    * <p/>
  +    * This property is only relevant if {@link #setRegisterPlainCache(boolean) registerPlainCache}
  +    * is <code>true</code>.
  +    * <p/>
  +    * Default is <code>true</code>.
       */
      void setRegisterInterceptors(boolean register);
   }