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