SetupHandler


1   /*
2    * This file is part of "SnipSnap Wiki/Weblog".
3    *
4    * Copyright (c) 2002,2003 Fraunhofer Gesellschaft
5    * Fraunhofer Institut for Computer Architecture and Software Technology
6    * All Rights Reserved.
7    *
8    * Please visit http://snipsnap.org/ for updates and contact.
9    *
10   * --LICENSE NOTICE--
11   * This program is free software; you can redistribute it and/or
12   * modify it under the terms of the GNU General Public License
13   * as published by the Free Software Foundation; either version 2
14   * of the License, or (at your option) any later version.
15   *
16   * This program is distributed in the hope that it will be useful,
17   * but WITHOUT ANY WARRANTY; without even the implied warranty of
18   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19   * GNU General Public License for more details.
20   *
21   * You should have received a copy of the GNU General Public License
22   * along with this program; if not, write to the Free Software
23   * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24   * --LICENSE NOTICE--
25   */
26  
27  package org.snipsnap.net.admin;
28  
29  import org.snipsnap.config.Configuration;
30  
31  import javax.servlet.http.HttpServletRequest  ;
32  import javax.servlet.http.HttpServletResponse  ;
33  import java.util.Map  ;
34  
35  /**
36   * A setup handler interface for SnipSnap configuration.
37   *
38   * @author Matthias L. Jugel
39   * @version $Id: SetupHandler.java 1606 2004-05-17 10:56:18Z leo $
40   */
41  public interface SetupHandler {
42    /**
43     * The name of this handler.
44     * @return a name
45     */
46    public String   getName();
47  
48    /**
49     * Called by setup if there is something to do for the handler.
50     *
51     * @param request the http servlet request (to get parameters etc).
52     * @param response the http servlet response (
53     * @param config the current configuration to make the changes in
54     * @param errors a map of errors to be set by the handler
55     */
56    public Map   setup(HttpServletRequest   request, HttpServletResponse   response, Configuration config, Map   errors);
57  }
58
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags