ParsingCacheMBean


1   /**
2    * Sequoia: Database clustering technology.
3    * Copyright (C) 2005 AmicoSoft, Inc. dba Emic Networks
4    * Contact: sequoia@continuent.org
5    * 
6    * Licensed under the Apache License, Version 2.0 (the "License");
7    * you may not use this file except in compliance with the License.
8    * You may obtain a copy of the License at
9    * 
10   * http://www.apache.org/licenses/LICENSE-2.0
11   * 
12   * Unless required by applicable law or agreed to in writing, software
13   * distributed under the License is distributed on an "AS IS" BASIS,
14   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   * See the License for the specific language governing permissions and
16   * limitations under the License. 
17   *
18   * Initial developer(s): Emmanuel Cecchet.
19   * Contributor(s): ______________________.
20   */
21  
22  package org.continuent.sequoia.common.jmx.mbeans;
23  
24  /**
25   * MBean Interface to manage the parsing cache
26   * 
27   * @see org.continuent.sequoia.common.jmx.JmxConstants#getParsingCacheObjectName(String)
28   */
29  public interface ParsingCacheMBean
30  {
31    /**
32     * Dumps the parsing cache configuration into a String.
33     * 
34     * @return parsing cache configuration
35     */
36    String   dumpCacheConfig();
37  
38    /**
39     * Dumps cache entries from the parsing cache.<br>
40     * The dump will be done by chuncks of predefined size. First call will start
41     * at entry index 0. Next calls will dump the next bunch of entries, until the
42     * end of the entry list. When all entries have been fetched, the function
43     * will return null and reset all counters to zero, making next call re-start
44     * a full dump
45     * 
46     * @see org.continuent.sequoia.controller.cache.parsing.ParsingCacheControl#ENTRIES_PER_DUMP
47     * @return a dump of the next parsing cache entries, or null if all entries
48     *         have been fetched
49     */
50    String   dumpNextCacheEntries();
51  
52    /**
53     * Resets the dump of the cache entries (next dump will restart from first
54     * entry)
55     * 
56     * @see #dumpNextCacheEntries()
57     */
58    void resetDump();
59  
60    /**
61     * Retrieves the requests that are currently beeing parsed
62     * 
63     * @return currently parsed entries as a string
64     */
65    String   dumpCurrentlyParsedEntries();
66  }
67
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags