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: import org.apache.excalibur.source.SourceValidity;
20: import java.io.Serializable;
21:
22: /**
23: * This marker interface declares a (sitemap) component as cacheable.
24: *
25: * This interface deprecates the org.apache.cocoon.caching.Cacheable interface!
26: *
27: * @since 2.1
28: * @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
29: * @version CVS $Id: CacheableProcessingComponent.java 433543 2006-08-22 06:22:54Z crossley $
30: */
31: public interface CacheableProcessingComponent {
32:
33: /**
34: * Generate the unique key.
35: * This key must be unique inside the space of this component.
36: * This method must be invoked before the getValidity() method.
37: *
38: * @return The generated key or <code>null</code> if the component
39: * is currently not cacheable.
40: */
41: Serializable getKey();
42:
43: /**
44: * Generate the validity object.
45: * Before this method can be invoked the getKey() method
46: * must be invoked.
47: *
48: * @return The generated validity object or <code>null</code> if the
49: * component is currently not cacheable.
50: */
51: SourceValidity getValidity();
52: }
|