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.caching;
18:
19: /**
20: * This marker interface declares a (sitemap) component as cacheable.
21: * Although this interface is deprecated it is still used for compatibility!
22: *
23: * @deprecated by the {@link CacheableProcessingComponent} interface
24: * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
25: * @version CVS $Id: Cacheable.java 433543 2006-08-22 06:22:54Z crossley $
26: */
27: public interface Cacheable {
28:
29: /**
30: * Generate the unique key.
31: * This key must be unique inside the space of this component.
32: * This method must be invoked before the generateValidity() method.
33: *
34: * @return The generated key or <code>0</code> if the component
35: * is currently not cacheable.
36: */
37: long generateKey();
38:
39: /**
40: * Generate the validity object.
41: * Before this method can be invoked the generateKey() method
42: * must be invoked.
43: *
44: * @return The generated validity object or <code>null</code> if the
45: * component is currently not cacheable.
46: */
47: CacheValidity generateValidity();
48: }
|