KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > caching > CacheableProcessingComponent


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