/* ============================================================================ The Apache Software License, Version 1.1 ============================================================================ Copyright (C) 1999-2002 The Apache Software Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modifica- tion, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear. 4. The names "Apache Cocoon" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org. 5. Products derived from this software may not be called "Apache", nor may "Apache" appear in their name, without prior written permission of the Apache Software Foundation. THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU- DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. This software consists of voluntary contributions made by many individuals on behalf of the Apache Software Foundation and was originally created by Stefano Mazzocchi . For more information on the Apache Software Foundation, please see . */ package fcc.ima.cocoon; import org.apache.avalon.framework.parameters.Parameters; import org.apache.cocoon.ProcessingException; import org.apache.cocoon.caching.CacheableProcessingComponent; import org.apache.cocoon.components.source.SourceUtil; import org.apache.cocoon.environment.Context; import org.apache.cocoon.environment.ObjectModelHelper; import org.apache.cocoon.environment.Response; import org.apache.cocoon.environment.SourceResolver; import org.apache.cocoon.reading.AbstractReader; import org.apache.excalibur.source.Source; import org.apache.excalibur.source.SourceException; import org.apache.excalibur.source.SourceValidity; import org.xml.sax.SAXException; import java.io.IOException; import java.io.InputStream; import java.util.Map; /** * The ResourceReader component is used to serve binary data * in a sitemap pipeline. It makes use of HTTP Headers to determine if * the requested resource should be written to the OutputStream * or if it can signal that it hasn't changed. * * Parameters: *
*
<expires>
*
This parameter is optional. When specified it determines how long * in miliseconds the resources can be cached by any proxy or browser * between Cocoon2 and the requesting visitor. *
*
* * @author Giacomo Pati * @version CVS $Id: ResourceReader.java,v 1.7.2.2 2002/06/05 01:36:11 vgritsenko Exp $ */ public class ResourceReader extends AbstractReader implements CacheableProcessingComponent { /** The source */ private Source inputSource; /** * Setup the reader. * The resource is opened to get an InputStream, * the length and the last modification date */ public void setup(SourceResolver resolver, Map objectModel, String src, Parameters par) throws ProcessingException, SAXException, IOException { super.setup(resolver, objectModel, src, par); try { inputSource = resolver.resolveURI(src); } catch (SourceException se) { throw SourceUtil.handle("Error during resolving of '" + src + "'.", se); } } public void recycle() { super.recycle(); this.inputSource = null; } /** * Generate the unique key. * This key must be unique inside the space of this component. * * @return The generated key hashes the src */ public java.io.Serializable getKey() { return inputSource.getURI(); } /** * Generate the validity object. * * @return The generated validity object or null if the * component is currently not cacheable. */ public SourceValidity getValidity() { return inputSource.getValidity(); } /** * @return the time the read source was last modified or 0 if it is not * possible to detect */ public long getLastModified() { return this.inputSource.getLastModified(); } /** * Generates the requested resource. */ public void generate() throws IOException, ProcessingException { final Response response = ObjectModelHelper.getResponse(this.objectModel); final long expires = parameters.getParameterAsInteger("expires", -1); if (expires > 0) { response.setDateHeader("Expires", System.currentTimeMillis() + expires); } long contentLength = this.inputSource.getContentLength(); if (contentLength != -1) { // FIXME (VG): Environment has setContentLength, and // Response interface has not. Strange. response.setHeader("Content-Length", Long.toString(contentLength)); } // Bug #9539: This resource reader does not support ranges response.setHeader("Accept-Ranges", "none"); byte[] buffer = new byte[8192]; int length = -1; InputStream inputStream = this.inputSource.getInputStream(); while ((length = inputStream.read(buffer)) > -1) { out.write(buffer, 0, length); } inputStream.close(); inputStream = null; out.flush(); } /** * Returns the mime-type of the resource in process. */ public String getMimeType () { Context ctx = ObjectModelHelper.getContext(this.objectModel); if (ctx != null) { return ctx.getMimeType(this.source); } else { return null; } } }