com.opencms.launcher
Interface I_CmsLauncher

All Known Implementing Classes:

com.opencms.launcher.A_CmsLauncher, CmsJspLoader

public interface I_CmsLauncher

Common interface for OpenCms launchers. Classes for each customized launcher have to be implemtented.

Version:

$Revision: 1.16 $ $Date: 2003/01/20 23:59:23 $

Author:

Alexander Lucas

Field Summary

static int	C_TYPE_DUMP Constants used as launcher IDs
static int	C_TYPE_JAVASCRIPT
static int	C_TYPE_JSP
static int	C_TYPE_LINK
static int	C_TYPE_PDF
static int	C_TYPE_VELOCITY
static int	C_TYPE_XML

Method Summary

void	clearCache()
int	getLauncherId() Gets the ID that indicates the type of the launcher.
void	initlaunch(CmsObject cms, CmsFile file, String startTemplateClass, A_OpenCms openCms) Start launch method called by the OpenCms system to show a resource
void	setOpenCms(A_OpenCms openCms) Sets the currently running OpenCms instance.

Field Detail

C_TYPE_DUMP

public static final int C_TYPE_DUMP

Constants used as launcher IDs

See Also:

Constant Field Values

C_TYPE_JAVASCRIPT

public static final int C_TYPE_JAVASCRIPT

See Also:

Constant Field Values

C_TYPE_XML

public static final int C_TYPE_XML

See Also:

Constant Field Values

C_TYPE_LINK

public static final int C_TYPE_LINK

See Also:

Constant Field Values

C_TYPE_PDF

public static final int C_TYPE_PDF

See Also:

Constant Field Values

C_TYPE_JSP

public static final int C_TYPE_JSP

See Also:

Constant Field Values

C_TYPE_VELOCITY

public static final int C_TYPE_VELOCITY

See Also:

Constant Field Values

Method Detail

clearCache

public void clearCache()

getLauncherId

public int getLauncherId()

Gets the ID that indicates the type of the launcher.

Returns:

launcher ID

initlaunch

public void initlaunch(CmsObject cms,
                       CmsFile file,
                       String startTemplateClass,
                       A_OpenCms openCms)
                throws CmsException

Start launch method called by the OpenCms system to show a resource

Parameters:

cms - CmsObject Object for accessing system resources.

file - CmsFile Object with the selected resource to be shown.

startTemplateClass - Name of the template class to start with.

openCms - a instance of A_OpenCms for redirect-needs

Throws:

CmsException

setOpenCms

public void setOpenCms(A_OpenCms openCms)

Sets the currently running OpenCms instance.