KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > transformation > helpers > IncludeCacheStorageProxy


1 /*
2  * Copyright 1999-2004 The Apache Software Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.apache.cocoon.transformation.helpers;
17
18 import java.io.IOException JavaDoc;
19 import java.io.Serializable JavaDoc;
20
21 /**
22  * A CacheStorageProxy is an interface object between the {@link IncludeCacheManager}
23  * and the real store caching the content.
24  * Currently you can use the {@link StoreIncludeCacheStorageProxy} that uses the
25  * usual store or the {@link ModifiableSourceIncludeCacheStorageProxy} that
26  * uses a configured source.
27  *
28  * @author <a HREF="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
29  * @version CVS $Id: IncludeCacheStorageProxy.java 30932 2004-07-29 17:35:38Z vgritsenko $
30  * @since 2.1
31  */
32 public interface IncludeCacheStorageProxy {
33
34     /**
35      * Get the cached content for the given URI.
36      * @param uri Absolute URI specifying the content
37      * @return Serializable
38      */
39     Serializable JavaDoc get(String JavaDoc uri);
40     
41     /**
42      * Put the content into the cache for the given URI.
43      * @param uri Absolute URI specifying the content
44      * @param object The content
45      * @throws IOException
46      */
47     void put(String JavaDoc uri, Serializable JavaDoc object)
48     throws IOException JavaDoc;
49     
50     /**
51      * Remove the cached content for the given URI
52      * @param uri Absolute URI specifying the content
53      */
54     void remove(String JavaDoc uri);
55 }
56
Popular Tags