KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > mq > server > MessageCacheMBean


1 /*
2 * JBoss, Home of Professional Open Source
3 * Copyright 2005, JBoss Inc., and individual contributors as indicated
4 * by the @authors tag. See the copyright.txt in the distribution for a
5 * full listing of individual contributors.
6 *
7 * This is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU Lesser General Public License as
9 * published by the Free Software Foundation; either version 2.1 of
10 * the License, or (at your option) any later version.
11 *
12 * This software is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this software; if not, write to the Free
19 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21 */
22 package org.jboss.mq.server;
23
24 /**
25  * MBean interface.
26  */
27 public interface MessageCacheMBean extends org.jboss.system.ServiceMBean
28 {
29
30    //default object name
31 public static final javax.management.ObjectName JavaDoc OBJECT_NAME = org.jboss.mx.util.ObjectNameFactory
32          .create("jboss.mq:service=MessageCache");
33
34    /**
35     * The <code>getInstance</code> method
36     * @return a <code>MessageCache</code> value
37     */
38    org.jboss.mq.server.MessageCache getInstance();
39
40    /**
41     * Gets the hardRefCacheSize
42     * @return Returns a int
43     */
44    int getHardRefCacheSize();
45
46    /**
47     * The <code>getSoftenedSize</code> method
48     * @return a <code>long</code> value
49     */
50    long getSoftenedSize();
51
52    /**
53     * Gets the softRefCacheSize
54     * @return Returns a int
55     */
56    int getSoftRefCacheSize();
57
58    /**
59     * Gets the totalCacheSize
60     * @return Returns a int
61     */
62    int getTotalCacheSize();
63
64    /**
65     * Gets the cacheMisses
66     * @return Returns a int
67     */
68    long getCacheMisses();
69
70    /**
71     * Gets the cacheHits
72     * @return Returns a long
73     */
74    long getCacheHits();
75
76    /**
77     * Gets whether to make soft references
78     * @return true when making soft references */
79    boolean getMakeSoftReferences();
80
81    /**
82     * Sets whether to make soft references
83     * @param true to make soft references */
84    void setMakeSoftReferences(boolean makeSoftReferences);
85
86    /**
87     * Gets the minimum number of hard messages
88     * @return the minimum number of hard messages */
89    int getMinimumHard();
90
91    /**
92     * Sets the minimum number of hard messages
93     * @param minimumHard the minimum number of hard messages */
94    void setMinimumHard(int minimumHard);
95
96    /**
97     * Gets the maximum number of hard messages
98     * @return the minimum number of hard messages */
99    int getMaximumHard();
100
101    /**
102     * Sets the maximum number of hard messages
103     * @param maximumHard the maximum number of hard messages */
104    void setMaximumHard(int maximumHard);
105
106    /**
107     * Gets the length of time to wait before checking whether we should soften
108     * @return the time to wait */
109    long getSoftenWaitMillis();
110
111    /**
112     * Sets the length of time to wait before checking whether we should soften
113     * @param millis the time to wait in millis */
114    void setSoftenWaitMillis(long millis);
115
116    /**
117     * Gets the minimum length between softening checks
118     * @return the time to wait */
119    long getSoftenNoMoreOftenThanMillis();
120
121    /**
122     * Sets the minimum length between softening checks
123     * @param wait the time between checks */
124    void setSoftenNoMoreOftenThanMillis(long millis);
125
126    /**
127     * Gets the maximum length between softening checks
128     * @return the time */
129    long getSoftenAtLeastEveryMillis();
130
131    /**
132     * Sets the minimum length between softening checks
133     * @param wait the time between checks */
134    void setSoftenAtLeastEveryMillis(long millis);
135
136    /**
137     * Gets the highMemoryMark
138     * @return Returns a long
139     */
140    long getHighMemoryMark();
141
142    /**
143     * Sets the highMemoryMark
144     * @param highMemoryMark The highMemoryMark to set
145     */
146    void setHighMemoryMark(long highMemoryMark);
147
148    /**
149     * Gets the maxMemoryMark
150     * @return Returns a long
151     */
152    long getMaxMemoryMark();
153
154    /**
155     * Sets the maxMemoryMark
156     * @param maxMemoryMark The maxMemoryMark to set
157     */
158    void setMaxMemoryMark(long maxMemoryMark);
159
160    /**
161     * Gets the CurrentMemoryUsage
162     * @return Returns a long
163     */
164    long getCurrentMemoryUsage();
165
166    void setCacheStore(javax.management.ObjectName JavaDoc cacheStoreName);
167
168    /**
169     * The <code>getCacheStore</code> method
170     * @return an <code>ObjectName</code> value
171     */
172    javax.management.ObjectName JavaDoc getCacheStore();
173
174 }
175
Popular Tags