001: /*
002: * $Id: XMLCache.java,v 1.3 2002/03/22 04:55:07 skavish Exp $
003: *
004: * ==========================================================================
005: *
006: * The JGenerator Software License, Version 1.0
007: *
008: * Copyright (c) 2000 Dmitry Skavish (skavish@usa.net). All rights reserved.
009: *
010: * Redistribution and use in source and binary forms, with or without
011: * modification, are permitted provided that the following conditions are met:
012: *
013: * 1. Redistributions of source code must retain the above copyright
014: * notice, this list of conditions and the following disclaimer.
015: *
016: * 2. Redistributions in binary form must reproduce the above copyright
017: * notice, this list of conditions and the following disclaimer in
018: * the documentation and/or other materials provided with the
019: * distribution.
020: *
021: * 3. The end-user documentation included with the redistribution, if
022: * any, must include the following acknowlegement:
023: * "This product includes software developed by Dmitry Skavish
024: * (skavish@usa.net, http://www.flashgap.com/)."
025: * Alternately, this acknowlegement may appear in the software itself,
026: * if and wherever such third-party acknowlegements normally appear.
027: *
028: * 4. The name "The JGenerator" must not be used to endorse or promote
029: * products derived from this software without prior written permission.
030: * For written permission, please contact skavish@usa.net.
031: *
032: * 5. Products derived from this software may not be called "The JGenerator"
033: * nor may "The JGenerator" appear in their names without prior written
034: * permission of Dmitry Skavish.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL DMITRY SKAVISH OR THE OTHER
040: * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: *
049: */
050:
051: package org.openlaszlo.iv.flash.cache;
052:
053: import org.openlaszlo.iv.flash.api.*;
054: import org.openlaszlo.iv.flash.util.*;
055: import org.openlaszlo.iv.flash.url.*;
056: import java.util.*;
057: import java.io.*;
058:
059: import org.w3c.dom.Document;
060:
061: /**
062: * Cache for parsed XML files
063: */
064: public class XMLCache extends GenericCache {
065:
066: private static XMLCache instance = new XMLCache();
067:
068: private XMLCache() {
069: }
070:
071: public static XMLCache getInstance() {
072: return instance;
073: }
074:
075: public static CacheSettings getSettings() {
076: return instance.getMySettings();
077: }
078:
079: /**
080: * Get cached Document
081: *
082: * @param key cache key
083: */
084: public static Document getXMLDocument(IVUrl url) {
085: return getXMLDocument(url.getName());
086: }
087:
088: /**
089: * Get cached Document
090: *
091: * @param key cache key
092: */
093: public static Document getXMLDocument(String key) {
094: CacheItem item = instance.getItem(key);
095: if (item == null)
096: return null;
097: return (Document) item.getObject();
098: }
099:
100: /**
101: * Add Document to cache
102: *
103: * @param url url of xml doc to cache
104: * @param doc xml document
105: */
106: public static void addXMLDocument(IVUrl url, Document doc) {
107: // check whether we need to cache or not
108: long lifespan = getSettings().getDefaultExpire();
109: if (!getSettings().isForce()) {
110: String gxcStr = url.getParameter("gxc");
111: if (gxcStr != null) {
112: if (!Util.toBool(gxcStr, false))
113: return;
114: String v = url.getParameter("gxe");
115: if (v != null) {
116: lifespan = Util.toLong(v, -1L) * 1000L;
117: }
118: } else {
119: return;
120: }
121: }
122: long now = System.currentTimeMillis();
123: if (lifespan <= 0) {
124: lifespan = Long.MAX_VALUE - now;
125: }
126: long expire = now + lifespan;
127: CacheItem item = new XMLCacheItem(url, doc, now, expire,
128: getSettings().isCheckModifiedSince());
129: instance.addItem(item);
130: }
131:
132: protected boolean isModified(CacheItem item) {
133: if (!getSettings().isCheckModifiedSince())
134: return super .isModified(item);
135: XMLCacheItem it = (XMLCacheItem) item;
136: it.getUrl().refresh();
137: return it.lastModified() != it.getUrl().lastModified();
138: }
139:
140: public static class XMLCacheItem extends CacheItem {
141: private long lastModified = 0;
142: private IVUrl url;
143:
144: public XMLCacheItem(IVUrl url, Document doc, long cacheTime,
145: long expireAfter, boolean isCheckModifiedSince) {
146: super (url.getName(), doc, 1, cacheTime, expireAfter);
147: this .url = url;
148: if (isCheckModifiedSince) {
149: this .lastModified = url.lastModified();
150: }
151: }
152:
153: public IVUrl getUrl() {
154: return url;
155: }
156:
157: public long lastModified() {
158: return lastModified;
159: }
160: }
161:
162: }
|