CacheManager.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.cocoon.forms;

import java.io.IOException;
import org.apache.excalibur.source.Source;

/**
 * Work interface for the component that caches objects for Cocoon Forms.
 *
 * @version $Id$
 */
public interface CacheManager {

    String ROLE = CacheManager.class.getName();

    /**
     * Retrieves an object from the cache.
     */
    Object get(Source source, String prefix);

    /**
     * Saves an object in the cache.
     */
    void set(Object object, Source source, String prefix) throws IOException;

    /**
     * Removes an object from the cache.
     */
    void remove(Source source, String prefix);
}