01: /*
02: * This file is part of PFIXCORE.
03: *
04: * PFIXCORE is free software; you can redistribute it and/or modify
05: * it under the terms of the GNU Lesser General Public License as published by
06: * the Free Software Foundation; either version 2 of the License, or
07: * (at your option) any later version.
08: *
09: * PFIXCORE is distributed in the hope that it will be useful,
10: * but WITHOUT ANY WARRANTY; without even the implied warranty of
11: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: * GNU Lesser General Public License for more details.
13: *
14: * You should have received a copy of the GNU Lesser General Public License
15: * along with PFIXCORE; if not, write to the Free Software
16: * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17: */
18:
19: package de.schlund.pfixxml.config;
20:
21: /**
22: * Provides configuration for an {@link de.schlund.pfixxml.AbstractXMLServlet} instance or one of its
23: * child classes.
24: *
25: * @author Sebastian Marsching <sebastian.marsching@1und1.de>
26: */
27: public interface AbstractXMLServletConfig extends ServletManagerConfig {
28:
29: /**
30: * Returns name for the servlet instance. This name is used to build attribute
31: * names which are used to store data within the servlet context and servlet
32: * session. This name has to be unique within the servlet context.
33: *
34: * @return Name for the servlet instance
35: */
36: String getServletName();
37:
38: /**
39: * Returns the path to the configuration file for the {@link de.schlund.pfixxml.targets.TargetGenerator}
40: * used by the {@link de.schlund.pfixxml.AbstractXMLServlet}. The path has to be specified relative
41: * to the Pustefix docroot.
42: *
43: * @return path to target generator configuration file
44: */
45: String getDependFile();
46:
47: /**
48: * If true the {@link de.schlund.pfixxml.AbstractXMLServlet} or its children allow the user to
49: * switch to "editmode" which provides extra debugging information.
50: *
51: * @return flag specifying whether to activate the edit mode
52: */
53: boolean isEditMode();
54:
55: }
|