001: /*
002: * Copyright (c) 1998-2008 Caucho Technology -- all rights reserved
003: *
004: * This file is part of Resin(R) Open Source
005: *
006: * Each copy or derived work must preserve the copyright notice and this
007: * notice unmodified.
008: *
009: * Resin Open Source is free software; you can redistribute it and/or modify
010: * it under the terms of the GNU General Public License as published by
011: * the Free Software Foundation; either version 2 of the License, or
012: * (at your option) any later version.
013: *
014: * Resin Open Source is distributed in the hope that it will be useful,
015: * but WITHOUT ANY WARRANTY; without even the implied warranty of
016: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, or any warranty
017: * of NON-INFRINGEMENT. See the GNU General Public License for more
018: * details.
019: *
020: * You should have received a copy of the GNU General Public License
021: * along with Resin Open Source; if not, write to the
022: *
023: * Free Software Foundation, Inc.
024: * 59 Temple Place, Suite 330
025: * Boston, MA 02111-1307 USA
026: *
027: * @author Scott Ferguson
028: */
029:
030: package com.caucho.management.server;
031:
032: import com.caucho.jmx.Description;
033: import com.caucho.jmx.Name;
034:
035: /**
036: * Management interface for the proxy cache.
037: *
038: * <pre>
039: * resin:type=ProxyCache
040: * </pre>
041: */
042: @Description("Resin's integrated proxy cache")
043: public interface ProxyCacheMXBean extends ManagedObjectMXBean {
044: //
045: // Statistics
046: //
047:
048: /**
049: * Returns the proxy cache hit count.
050: */
051: @Description("The proxy cache is used to cache responses that" + " set appropriate HTTP headers")
052: public long getHitCountTotal();
053:
054: /**
055: * Returns the proxy cache miss count.
056: */
057: @Description("The proxy cache is used to cache responses that" + " set appropriate HTTP headers")
058: public long getMissCountTotal();
059:
060: /**
061: * Return most used cacheable connections.
062: */
063: public CacheItem[] getCacheableEntries(int max);
064:
065: /**
066: * Return most used uncacheable connections.
067: */
068: public CacheItem[] getUncacheableEntries(int max);
069:
070: //
071: // Operations
072: //
073:
074: /**
075: * Clears the cache.
076: */
077: @Description("Clear the cache")
078: public void clearCache();
079:
080: /**
081: * Clears the cache by regexp patterns.
082: *
083: * @param hostRegexp the regexp to match the host. Null matches all.
084: * @param urlRegexp the regexp to match the url. Null matches all.
085: */
086: @Description("Selectively clear the cache using patterns")
087: public void clearCacheByPattern(
088: @Name("hostRegexp")
089: @Description("A regular expression that matches a host name, null to match all host names")
090: String hostRegexp,
091:
092: @Name("urlRegexp")
093: @Description("A regular expression that matches a url, null to match all urls")
094: String urlRegexp);
095:
096: /**
097: * Clears the expires timers for the cache.
098: */
099: @Description("Clear expires")
100: public void clearExpires();
101: }
|