Source code: com/opencms/launcher/I_CmsLauncher.java
1 /*
2 * File : $Source: /usr/local/cvs/opencms/src/com/opencms/launcher/Attic/I_CmsLauncher.java,v $
3 * Date : $Date: 2003/01/20 23:59:23 $
4 * Version: $Revision: 1.16 $
5 *
6 * This library is part of OpenCms -
7 * the Open Source Content Mananagement System
8 *
9 * Copyright (C) 2001 The OpenCms Group
10 *
11 * This library is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public
13 * License as published by the Free Software Foundation; either
14 * version 2.1 of the License, or (at your option) any later version.
15 *
16 * This library 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 GNU
19 * Lesser General Public License for more details.
20 *
21 * For further information about OpenCms, please see the
22 * OpenCms Website: http://www.opencms.org
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27 */
28
29 package com.opencms.launcher;
30
31 import com.opencms.core.A_OpenCms;
32 import com.opencms.core.CmsException;
33 import com.opencms.file.CmsFile;
34 import com.opencms.file.CmsObject;
35
36 /**
37 * Common interface for OpenCms launchers.
38 * Classes for each customized launcher have to be implemtented.
39 *
40 * @author Alexander Lucas
41 * @version $Revision: 1.16 $ $Date: 2003/01/20 23:59:23 $
42 */
43 public interface I_CmsLauncher {
44
45 /** Constants used as launcher IDs */
46 public final static int C_TYPE_DUMP = 1;
47 public final static int C_TYPE_JAVASCRIPT = 2;
48 public final static int C_TYPE_XML = 3;
49 public final static int C_TYPE_LINK = 4;
50 public final static int C_TYPE_PDF = 5;
51 public final static int C_TYPE_JSP = 6;
52 public final static int C_TYPE_VELOCITY = 7;
53
54 public void clearCache();
55
56 /**
57 * Gets the ID that indicates the type of the launcher.
58 * @return launcher ID
59 */
60 public int getLauncherId();
61
62 /**
63 * Start launch method called by the OpenCms system to show a resource
64 *
65 * @param cms CmsObject Object for accessing system resources.
66 * @param file CmsFile Object with the selected resource to be shown.
67 * @param startTemplateClass Name of the template class to start with.
68 * @param openCms a instance of A_OpenCms for redirect-needs
69 * @throws CmsException
70 */
71 public void initlaunch(CmsObject cms, CmsFile file, String startTemplateClass, A_OpenCms openCms) throws CmsException;
72
73 /**
74 * Sets the currently running OpenCms instance.
75 */
76 public void setOpenCms(A_OpenCms openCms);
77 }