Package com.opencms.core

This package provides the classes used to access OpenCms resources by a servlet (or the OpenCms shell).

See:
Description

Interface Summary

I_CmsCheckResource	This interface checks the requested resource from the OpenCms request context and returns it to the calling method, which will usually be OpenCms.initResource(cms).
I_CmsConstants	This interface is a pool for constants in OpenCms.
I_CmsCronJob	This interface identifies an Object that can be started as a cronjob.
I_CmsRequest	This interface defines an OpenCms request, a generic request object that is used by OpenCms and provides methods to read the data included in the request.
I_CmsResponse	This interface defines an OpenCms response, a generic response object that is used by OpenCms and provides methods to send processed data back to the requesting user.
I_CmsSession	This interface defines an OpenCms session, a generic session object that is used by OpenCms and provides methods to access the current users session data.

Class Summary

A_OpenCms	Abstract class for the OpenCms "operating system" that provides public static methods which can be used by other classes to access basic features of OpenCms like logging etc.
CmsCoreSession	This class implements a session storage which is mainly used to count the currently logged in OpenCms users.
CmsExportRequest	Implementation of the I_CmsRequest interface which is used to request pages during a static export.
CmsExportResponse	Implementation of the I_CmsResponse interface which is used as response buffer for pages during a static export.
CmsRequestHttpServlet	Implementation of the I_CmsRequest interface which wraps a HttpServletRequest and includes handling of multipart - requests.
CmsResponseHttpServlet	Implementation of the I_CmsResponse interface which wraps a HttpServletResponse and provides OpenCms with a facility to handle redirects.
CmsSession	Implements the I_CmsSession interface and is required by the OpenCms session handling mechanism.
CmsShell	This class is a commad line interface to OpenCms which can be used for the initial setup and to test the system.
CmsStaticExportProperties	This class provides a special data structure to access the static export properties read from opencms.properties.
OpenCms	This class is the main class of the OpenCms system, think of it as the "operating system" of OpenCms.
OpenCmsHttpServlet	This the main servlet of the OpenCms system.

Exception Summary

CmsException

This class provides OpenCms interal Exception handling.

Package com.opencms.core Description

This package provides the classes used to access OpenCms resources by a servlet (or the OpenCms shell). There are currently 2 main ways to acess resources in an OpenCms System:

1. Using the OpenCmsHttpServlet. This is the default usage of the OpenCms system.
2. Using the CmsShell. This is done for specific reasons, usually related to system configuration or setup.

The other classes in this package are utility classes used for wrapping the request context (usually of a HttpServletRequest) and some interfaces.

See Also:

A_OpenCms, OpenCms, OpenCmsHttpServlet, CmsShell