ProxyCacheMXBean


1   /*
2    * Copyright (c) 1998-2006 Caucho Technology -- all rights reserved
3    *
4    * This file is part of Resin(R) Open Source
5    *
6    * Each copy or derived work must preserve the copyright notice and this
7    * notice unmodified.
8    *
9    * Resin Open Source is free software; you can redistribute it and/or modify
10   * it under the terms of the GNU General Public License as published by
11   * the Free Software Foundation; either version 2 of the License, or
12   * (at your option) any later version.
13   *
14   * Resin Open Source is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
17   * of NON-INFRINGEMENT.  See the GNU General Public License for more
18   * details.
19   *
20   * You should have received a copy of the GNU General Public License
21   * along with Resin Open Source; if not, write to the
22   *
23   *   Free Software Foundation, Inc.
24   *   59 Temple Place, Suite 330
25   *   Boston, MA 02111-1307  USA
26   *
27   * @author Scott Ferguson
28   */
29  
30  package com.caucho.management.server;
31  
32  import com.caucho.jmx.Description;
33  import com.caucho.jmx.Name;
34  
35  /**
36   * Management interface for the proxy cache.
37   *
38   * <pre>
39   * resin:type=ProxyCache
40   * </pre>
41   */
42  @Description("Resin's integrated proxy cache")
43  public interface ProxyCacheMXBean extends ManagedObjectMXBean {
44    //
45    // Statistics
46    //
47    
48    /**
49     * Returns the proxy cache hit count.
50     */
51    @Description("The proxy cache is used to cache responses that"
52                 + " set appropriate HTTP headers")
53    public long getHitCountTotal();
54  
55    /**
56     * Returns the proxy cache miss count.
57     */
58    @Description("The proxy cache is used to cache responses that"
59                 + " set appropriate HTTP headers")
60    public long getMissCountTotal();
61  
62    //
63    // Operations
64    //
65  
66    /**
67     * Clears the cache.
68     */
69    @Description("Clear the cache")
70    public void clearCache();
71  
72    /**
73     * Clears the cache by regexp patterns.
74     *
75     * @param hostRegexp the regexp to match the host.  Null matches all.
76     * @param urlRegexp the regexp to match the url. Null matches all.
77     */
78    @Description("Selectively clear the cache using patterns")
79    public void clearCacheByPattern(
80      @Name("hostRegexp")
81      @Description("A regular expression that matches a host name, null to match all host names")
82      String   hostRegexp,
83  
84      @Name("urlRegexp")
85      @Description("A regular expression that matches a url, null to match all urls")
86      String   urlRegexp);
87  }
88
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags