01: /*
02: * SSICommand.java
03: * $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/ssi/SSICommand.java,v 1.1 2002/05/24 16:35:39 glenn Exp $
04: * $Revision: 1.1 $
05: * $Date: 2002/05/24 16:35:39 $
06: *
07: * ====================================================================
08: *
09: * The Apache Software License, Version 1.1
10: *
11: * Copyright (c) 1999 The Apache Software Foundation. All rights
12: * reserved.
13: *
14: * Redistribution and use in source and binary forms, with or without
15: * modification, are permitted provided that the following conditions
16: * are met:
17: *
18: * 1. Redistributions of source code must retain the above copyright
19: * notice, this list of conditions and the following disclaimer.
20: *
21: * 2. Redistributions in binary form must reproduce the above copyright
22: * notice, this list of conditions and the following disclaimer in
23: * the documentation and/or other materials provided with the
24: * distribution.
25: *
26: * 3. The end-user documentation included with the redistribution, if
27: * any, must include the following acknowlegement:
28: * "This product includes software developed by the
29: * Apache Software Foundation (http://www.apache.org/)."
30: * Alternately, this acknowlegement may appear in the software itself,
31: * if and wherever such third-party acknowlegements normally appear.
32: *
33: * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
34: * Foundation" must not be used to endorse or promote products derived
35: * from this software without prior written permission. For written
36: * permission, please contact apache@apache.org.
37: *
38: * 5. Products derived from this software may not be called "Apache"
39: * nor may "Apache" appear in their names without prior written
40: * permission of the Apache Group.
41: *
42: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
43: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
44: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
45: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
46: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
49: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
50: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
51: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
52: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
53: * SUCH DAMAGE.
54: * ====================================================================
55: *
56: * This software consists of voluntary contributions made by many
57: * individuals on behalf of the Apache Software Foundation. For more
58: * information on the Apache Software Foundation, please see
59: * <http://www.apache.org/>.
60: *
61: * [Additional notices, if required by prior licensing conditions]
62: *
63: */
64: package org.apache.catalina.ssi;
65:
66: import java.io.IOException;
67: import java.io.PrintWriter;
68:
69: /**
70: * The interface that all SSI commands ( SSIEcho, SSIInclude, ...) must implement.
71: *
72: * @author Bip Thelin
73: * @author Dan Sandberg
74: * @version $Revision: 1.1 $, $Date: 2002/05/24 16:35:39 $
75: *
76: */
77: public interface SSICommand {
78: /**
79: * Write the output of the command to the writer.
80: *
81: * @param ssiMediator the ssi mediator
82: * @param paramNames The parameter names
83: * @param paramValues The parameter values
84: * @param writer the writer to output to
85: * @throws SSIStopProcessingException if SSI processing should be aborted
86: */
87: public void process(SSIMediator ssiMediator, String[] paramNames,
88: String[] paramValues, PrintWriter writer)
89: throws SSIStopProcessingException;
90: }
|