org.apache.catalina.ssi

Interface SSIExternalResolver

Known Implementing Classes:
SSIServletExternalResolver

public interface SSIExternalResolver

Interface used by SSIMediator to talk to the 'outside world' ( usually a servlet )

Version:
$Revision: 1.3.2.1 $, $Date: 2004/09/01 16:31:01 $

Author:
Dan Sandberg

Method Summary

void
addVariableNames(Collection variableNames)
Adds any external variables to the variableNames collection.
Date
getCurrentDate()
Returns the current date.
long
getFileLastModified(String path, boolean virtual)
long
getFileSize(String path, boolean virtual)
String
getFileText(String path, boolean virtual)
String
getVariableValue(String name)
void
log(String message, Throwable throwable)
void
setVariableValue(String name, String value)
Set the named variable to the specified value.

Method Details

addVariableNames

public void addVariableNames(Collection variableNames)
Adds any external variables to the variableNames collection.

Parameters:
variableNames - the collection to add to


getCurrentDate

public Date getCurrentDate()
Returns the current date. This is useful for putting the SSI stuff in a regression test. Since you can make the current date a constant, it makes testing easier since the output won't change.

Returns:
the data


getFileLastModified

public long getFileLastModified(String path,
                                boolean virtual)
            throws IOException


getFileSize

public long getFileSize(String path,
                        boolean virtual)
            throws IOException


getFileText

public String getFileText(String path,
                          boolean virtual)
            throws IOException


getVariableValue

public String getVariableValue(String name)


log

public void log(String message,
                Throwable throwable)


setVariableValue

public void setVariableValue(String name,
                             String value)
Set the named variable to the specified value. If value is null, then the variable will be removed ( ie. a call to getVariableValue will return null )

Parameters:
name - of the variable
value - of the variable


Copyright B) 2000-2003 Apache Software Foundation. All Rights Reserved.