1 /**
2 * This file Copyright (c) 2003-2014 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.cms.servlets;
35
36 import java.io.IOException;
37
38
39 /**
40 * This Handler is used in the MVCServlet.
41 * @version $Id$
42 */
43 public interface MVCServletHandler {
44
45 String VIEW_NOTHING = "nothing"; //$NON-NLS-1$
46
47 /**
48 * Returns the name of the command we want to execute.
49 * @return name of the command
50 */
51 String getCommand();
52
53 /**
54 * Execute the command. Returns the view name.
55 * @return the name of the view to show (used in renderHtml)
56 */
57 String execute(String command);
58
59 /**
60 * Render the tree depending on the view name.
61 * @param view
62 * @return
63 * @throws IOException
64 */
65 void renderHtml(String view) throws IOException;
66
67 /**
68 * The name of the handler.
69 */
70 String getName();
71
72 /**
73 * Called after instantiating.
74 */
75 void init() throws Exception;
76 }