KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > caucho > server > cache > AbstractCache


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  * Free SoftwareFoundation, Inc.
23  * 59 Temple Place, Suite 330
24  * Boston, MA 02111-1307 USA
25  *
26  * @author Scott Ferguson
27  */
28
29 package com.caucho.server.cache;
30
31 import com.caucho.config.types.Bytes;
32 import com.caucho.server.webapp.WebApp;
33 import com.caucho.vfs.Path;
34
35 import javax.servlet.FilterChain JavaDoc;
36
37 /**
38  * Cached response.
39  */
40 abstract public class AbstractCache {
41   /**
42    * Sets the path to the cache directory.
43    */
44   abstract public void setPath(Path path);
45   
46   /**
47    * Returns the path from the cache directory.
48    */
49   abstract public Path getPath();
50
51   /**
52    * Sets the disk size of the cache
53    */
54   abstract public void setDiskSize(Bytes size);
55
56   /**
57    * Sets the max entry size of the cache
58    */
59   abstract public int getMaxEntrySize();
60
61   /**
62    * Set true if enabled.
63    */
64   abstract public void setEnable(boolean isEnabled);
65
66   /**
67    * Return true if enabled.
68    */
69   abstract public boolean isEnable();
70
71   /**
72    * Sets the max number of entries.
73    */
74   abstract public void setEntries(int entries);
75
76   /**
77    * Sets the path to the cache directory (backwards compatibility).
78    */
79   abstract public void setDir(Path path);
80
81   /**
82    * Sets the size of the the cache (backwards compatibility).
83    */
84   abstract public void setSize(Bytes size);
85   
86   /**
87    * Creates the filter.
88    */
89   abstract public FilterChain JavaDoc createFilterChain(FilterChain JavaDoc next,
90                         WebApp app);
91
92   /**
93    * Clears the cache.
94    */
95   abstract public void clear();
96
97   /**
98    * Returns the hit count.
99    */
100   abstract public long getHitCount();
101
102   /**
103    * Returns the miss count.
104    */
105   abstract public long getMissCount();
106
107   /**
108    * Returns the memory block hit count.
109    */
110   abstract public long getMemoryBlockHitCount();
111
112   /**
113    * Returns the memory block miss count.
114    */
115   abstract public long getMemoryBlockMissCount();
116 }
117
Popular Tags