001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: */
017: package org.apache.portals.applications.transform;
018:
019: import java.util.Comparator;
020: import java.util.Observer;
021:
022: /**
023: * TransformCache
024: *
025: * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
026: * @version $Id: TransformCache.java 516448 2007-03-09 16:25:47Z ate $
027: */
028: public interface TransformCache extends Observer, Comparator {
029: /**
030: * Get the maximum size of the cache
031: *
032: * @return the current maximum size of the cache
033: */
034: public int getMaxSize();
035:
036: /**
037: * Set the new maximum size of the cache
038: *
039: * @param maxSize the maximum size of the cache
040: */
041: public void setMaxSize(int maxSize);
042:
043: /**
044: * Get the eviction percentage of the cache
045: *
046: * @return the eviction percentage of the cache
047: */
048: public int getEvictionPercentage();
049:
050: /**
051: * Find out if TransformCache is enables
052: *
053: * @return the enable flag of the cache
054: */
055: public boolean isEnabled();
056:
057: /**
058: * Put a value in the TransformCache keyed off with the TransformId and the
059: * DocumentId.
060: * @param key
061: * @param document
062: */
063: public void put(String key, Object document, long timeToLive);
064:
065: /**
066: * Remove a unique value keyed off with the TransformId and DocumentId from the
067: * cache.
068: * @param key
069: * @return Object
070: */
071: public Object remove(String key);
072:
073: /**
074: * Retrieve the unique TransformCacheEntry keyed off with key
075: * @param key
076: * @return TransformCacheEntry
077: */
078: public TransformCacheEntry get(String key);
079:
080: /**
081: * Retrieve the byte[] storing the transformed content for the transfomId
082: * and the documentId combination.
083: * @param transformId
084: * @param documentId
085: * @return Object
086: */
087: public Object getDocument(String key);
088:
089: /**
090: * Construct the key for the TransformDocumentTreeMap cache
091: * @return String
092: */
093: public String constructKey(String url, String stylesheet);
094:
095: /**
096: * Clear the Transform Cache
097: */
098: public void clearCache();
099:
100: }
|