1 package org.apache.turbine.services.cache;
2
3 /* ====================================================================
4 * The Apache Software License, Version 1.1
5 *
6 * Copyright (c) 2001 The Apache Software Foundation. All rights
7 * reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 *
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 *
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in
18 * the documentation and/or other materials provided with the
19 * distribution.
20 *
21 * 3. The end-user documentation included with the redistribution,
22 * if any, must include the following acknowledgment:
23 * "This product includes software developed by the
24 * Apache Software Foundation (http://www.apache.org/)."
25 * Alternately, this acknowledgment may appear in the software itself,
26 * if and wherever such third-party acknowledgments normally appear.
27 *
28 * 4. The names "Apache" and "Apache Software Foundation" and
29 * "Apache Turbine" must not be used to endorse or promote products
30 * derived from this software without prior written permission. For
31 * written permission, please contact apache@apache.org.
32 *
33 * 5. Products derived from this software may not be called "Apache",
34 * "Apache Turbine", nor may "Apache" appear in their name, without
35 * prior written permission of the Apache Software Foundation.
36 *
37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
48 * SUCH DAMAGE.
49 * ====================================================================
50 *
51 * This software consists of voluntary contributions made by many
52 * individuals on behalf of the Apache Software Foundation. For more
53 * information on the Apache Software Foundation, please see
54 * <http://www.apache.org/>.
55 */
56
57 import java.io.IOException;
58 import org.apache.turbine.services.TurbineServices;
59
60 /***
61 * This is a Facade class for GlobalCacheService.
62 *
63 * This class provides static methods that call related methods of the
64 * implementation of the GlobalCacheService used by the System, according to
65 * the settings in TurbineResources.
66 *
67 * @author <a href="mailto:sean@informage.net">Sean Legassick</a>
68 * @version $Id: TurbineGlobalCache.java,v 1.3 2002/07/11 16:53:28 mpoeschl Exp $
69 */
70 public abstract class TurbineGlobalCache
71 {
72 /***
73 * Utility method for accessing the service
74 * implementation
75 *
76 * @return a GlobalCacheService implementation instance
77 */
78 protected static GlobalCacheService getService()
79 {
80 return (GlobalCacheService)TurbineServices
81 .getInstance().getService(GlobalCacheService.SERVICE_NAME);
82 }
83
84
85 /***
86 * Gets a cached object given its id (a String).
87 *
88 * @param id The String id for the object.
89 * @return A CachedObject.
90 * @exception ObjectExpiredException, if the object has expired in
91 * the cache.
92 */
93 public static CachedObject getObject(String id)
94 throws ObjectExpiredException
95 {
96 return getService().getObject(id);
97 }
98
99 /***
100 * Adds an object to the cache.
101 *
102 * @param id The String id for the object.
103 * @param o The object to add to the cache.
104 */
105 public static void addObject(String id,
106 CachedObject o)
107 {
108 getService().addObject(id, o);
109 }
110
111 /***
112 * Removes an object from the cache.
113 *
114 * @param id The String id for the object.
115 */
116 public static void removeObject(String id)
117 {
118 getService().removeObject(id);
119 }
120
121 /***
122 * Returns the current size of the cache.
123 * @return int representing current cache size in number of bytes
124 */
125 public static int getCacheSize()
126 throws IOException
127 {
128 return getService().getCacheSize();
129 }
130
131 /***
132 * Returns the number of objects in the cache.
133 * @return int The current number of objects in the cache.
134 */
135 public static int getNumberOfObjects()
136 {
137 return getService().getNumberOfObjects();
138 }
139 }
This page was automatically generated by Maven