01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.catalina.ssi;
18:
19: import java.io.PrintWriter;
20:
21: /**
22: * The interface that all SSI commands ( SSIEcho, SSIInclude, ...) must
23: * implement.
24: *
25: * @author Bip Thelin
26: * @author Dan Sandberg
27: * @author David Becker
28: * @version $Revision: 531303 $, $Date: 2007-04-23 02:24:01 +0200 (lun., 23 avr. 2007) $
29: */
30: public interface SSICommand {
31: /**
32: * Write the output of the command to the writer.
33: *
34: * @param ssiMediator
35: * the ssi mediator
36: * @param commandName
37: * the name of the actual command ( ie. echo )
38: * @param paramNames
39: * The parameter names
40: * @param paramValues
41: * The parameter values
42: * @param writer
43: * the writer to output to
44: * @return the most current modified date resulting from any SSI commands
45: * @throws SSIStopProcessingException
46: * if SSI processing should be aborted
47: */
48: public long process(SSIMediator ssiMediator, String commandName,
49: String[] paramNames, String[] paramValues,
50: PrintWriter writer) throws SSIStopProcessingException;
51: }
|