001: /*
002: * SSIExternalResolver.java
003: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/ssi/SSIExternalResolver.java,v 1.1 2002/05/24 04:38:58 billbarker Exp $
004: * $Revision: 1.1 $
005: * $Date: 2002/05/24 04:38:58 $
006: *
007: * ====================================================================
008: *
009: * The Apache Software License, Version 1.1
010: *
011: * Copyright (c) 1999 The Apache Software Foundation. All rights
012: * reserved.
013: *
014: * Redistribution and use in source and binary forms, with or without
015: * modification, are permitted provided that the following conditions
016: * are met:
017: *
018: * 1. Redistributions of source code must retain the above copyright
019: * notice, this list of conditions and the following disclaimer.
020: *
021: * 2. Redistributions in binary form must reproduce the above copyright
022: * notice, this list of conditions and the following disclaimer in
023: * the documentation and/or other materials provided with the
024: * distribution.
025: *
026: * 3. The end-user documentation included with the redistribution, if
027: * any, must include the following acknowlegement:
028: * "This product includes software developed by the
029: * Apache Software Foundation (http://www.apache.org/)."
030: * Alternately, this acknowlegement may appear in the software itself,
031: * if and wherever such third-party acknowlegements normally appear.
032: *
033: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
034: * Foundation" must not be used to endorse or promote products derived
035: * from this software without prior written permission. For written
036: * permission, please contact apache@apache.org.
037: *
038: * 5. Products derived from this software may not be called "Apache"
039: * nor may "Apache" appear in their names without prior written
040: * permission of the Apache Group.
041: *
042: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
043: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
044: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
045: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
046: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
047: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
048: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
049: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
050: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
051: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
052: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
053: * SUCH DAMAGE.
054: * ====================================================================
055: *
056: * This software consists of voluntary contributions made by many
057: * individuals on behalf of the Apache Software Foundation. For more
058: * information on the Apache Software Foundation, please see
059: * <http://www.apache.org/>.
060: *
061: * [Additional notices, if required by prior licensing conditions]
062: *
063: */
064: package org.apache.catalina.ssi;
065:
066: import java.io.IOException;
067: import java.io.PrintWriter;
068: import java.util.Collection;
069: import java.util.Date;
070:
071: /**
072: * Interface used by SSIMediator to talk to the 'outside world' ( usually a servlet )
073: *
074: * @author Dan Sandberg
075: * @version $Revision: 1.1 $, $Date: 2002/05/24 04:38:58 $
076: *
077: */
078: public interface SSIExternalResolver {
079: /**
080: * Adds any external variables to the variableNames collection.
081: *
082: * @param variableNames the collection to add to
083: */
084: public void addVariableNames(Collection variableNames);
085:
086: public String getVariableValue(String name);
087:
088: /**
089: * Set the named variable to the specified value.
090: *
091: * If value is null, then the variable will be removed ( ie.
092: * a call to getVariableValue will return null )
093: *
094: * @param name of the variable
095: * @param value of the variable
096: */
097: public void setVariableValue(String name, String value);
098:
099: /**
100: * Returns the current date.
101: *
102: * This is useful for putting the SSI stuff in a regression test. Since you can make the current date a
103: * constant, it makes testing easier since the output won't change.
104: *
105: * @return the data
106: */
107: public Date getCurrentDate();
108:
109: public long getFileSize(String path, boolean virtual)
110: throws IOException;
111:
112: public long getFileLastModified(String path, boolean virtual)
113: throws IOException;
114:
115: public String getFileText(String path, boolean virtual)
116: throws IOException;
117:
118: public void log(String message, Throwable throwable);
119: }
|