SSICommand


1   /*
2    * Copyright 1999,2004 The Apache Software Foundation. Licensed under the
3    * Apache License, Version 2.0 (the "License"); you may not use this file
4    * except in compliance with the License. You may obtain a copy of the License
5    * at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable
6    * law or agreed to in writing, software distributed under the License is
7    * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8    * KIND, either express or implied. See the License for the specific language
9    * governing permissions and limitations under the License.
10   */
11  package org.apache.catalina.ssi;
12  
13  
14  import java.io.PrintWriter  ;
15  /**
16   * The interface that all SSI commands ( SSIEcho, SSIInclude, ...) must
17   * implement.
18   * 
19   * @author Bip Thelin
20   * @author Dan Sandberg
21   * @author David Becker
22   * @version $Revision: 467222 $, $Date: 2006-10-24 05:17:11 +0200 (mar., 24 oct. 2006) $
23   */
24  public interface SSICommand {
25      /**
26       * Write the output of the command to the writer.
27       * 
28       * @param ssiMediator
29       *            the ssi mediator
30       * @param commandName
31       *            the name of the actual command ( ie. echo )
32       * @param paramNames
33       *            The parameter names
34       * @param paramValues
35       *            The parameter values
36       * @param writer
37       *            the writer to output to
38       * @return the most current modified date resulting from any SSI commands
39       * @throws SSIStopProcessingException
40       *             if SSI processing should be aborted
41       */
42      public long process(SSIMediator ssiMediator, String   commandName,
43              String  [] paramNames, String  [] paramValues, PrintWriter   writer)
44              throws SSIStopProcessingException;
45  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags