01: /**
02: * Sequoia: Database clustering technology.
03: * Copyright (C) 2005 AmicoSoft, Inc. dba Emic Networks
04: * Contact: sequoia@continuent.org
05: *
06: * Licensed under the Apache License, Version 2.0 (the "License");
07: * you may not use this file except in compliance with the License.
08: * You may obtain a copy of the License at
09: *
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: */package org.continuent.sequoia.common.jmx.mbeans;
21:
22: /**
23: * MBean Interface to manage the parsing cache
24: *
25: * @see org.continuent.sequoia.common.jmx.JmxConstants#getParsingCacheObjectName(String)
26: */
27: public interface ParsingCacheMBean {
28: /**
29: * Dumps the parsing cache configuration into a String.
30: *
31: * @return parsing cache configuration
32: */
33: String dumpCacheConfig();
34:
35: /**
36: * Dumps cache entries from the parsing cache.<br>
37: * The dump will be done by chuncks of predefined size. First call will start
38: * at entry index 0. Next calls will dump the next bunch of entries, until the
39: * end of the entry list. When all entries have been fetched, the function
40: * will return null and reset all counters to zero, making next call re-start
41: * a full dump
42: *
43: * @see org.continuent.sequoia.controller.cache.parsing.ParsingCacheControl#ENTRIES_PER_DUMP
44: * @return a dump of the next parsing cache entries, or null if all entries
45: * have been fetched
46: */
47: String dumpNextCacheEntries();
48:
49: /**
50: * Resets the dump of the cache entries (next dump will restart from first
51: * entry)
52: *
53: * @see #dumpNextCacheEntries()
54: */
55: void resetDump();
56:
57: /**
58: * Retrieves the requests that are currently beeing parsed
59: *
60: * @return currently parsed entries as a string
61: */
62: String dumpCurrentlyParsedEntries();
63: }
|