Package org.opencms.main

Provides the main OpenCms "operating system".

See:
Description

Interface Summary

I_CmsEventListener	Implement this interface in case your class has to react to CmsEvents that are thrown by system.
I_CmsRequestHandler	Describes an OpenCms request handler.
I_CmsResourceInit	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_CmsShellCommands	Provides scriptable access to a class from the CmsShell.
I_CmsThrowable	Provides localized Exception handling based on the OpenCms default locale.

Class Summary

CmsBroadcast	A single broadcast message, send from one OpenCms user to another.
CmsContextInfo	Contains user information for automated creation of a CmsRequestContext during system runtime.
CmsEvent	Event class for OpenCms for system wide events that are thrown by various operations (e.g.
CmsHttpAuthenticationSettings	Contains the settings to handle HTTP basic authentication.
CmsLog	Provides the OpenCms logging mechanism.
CmsSessionInfo	Stores information about a user that has authenticated himself the OpenCms security system.
CmsSessionManager	Keeps track of the sessions running on the OpenCms server and provides a session info storage which is used to get an overview about currently authenticated OpenCms users, as well as sending broadcasts between users.
CmsShell	A commad line interface to access OpenCms functions which is used for the initial setup and also can be used to directly access the OpenCms repository without the Workplace.
CmsSystemInfo	Provides access to system wide "read only" information.
CmsThreadStore	The OpenCms Thread store where all system Threads are maintained.
Messages	Convenience class to access the localized messages of this OpenCms package.
OpenCms	The OpenCms "operating system" that provides public static methods which can be used by other classes to access basic system features of OpenCms like logging etc.
OpenCmsCore	The internal implementation of the core OpenCms "operating system" functions.
OpenCmsListener	Provides the OpenCms system with information from the servlet context.
OpenCmsServlet	This the main servlet of the OpenCms system.

Exception Summary

CmsException	Master exception type for all exceptions caused in OpenCms.
CmsIllegalArgumentException	A replacement for IllegalArgumentException to obtain fully localized exception messages for OpenCms.
CmsIllegalStateException	A replacement for IllegalStateException to obtain fully localized exception messages for OpenCms.
CmsInitException	Describes errors that occur in the context of OpenCms the initialization, this is fatal and prevents OpenCms from starting.
CmsResourceInitException	This exeption is thrown by a class which implements org.opencms.main.I_CmsResourceInit.
CmsRuntimeException	A replacement for RuntimeException to obtain fully localized exception messages for OpenCms.

Package org.opencms.main Description

Provides the main OpenCms "operating system".

There are 3 main ways to access resources in an OpenCms System:

1. Using the OpenCmsServlet. 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.
3. Using the OpenCms.initCmsObject(String) from an application to obtain an initialized OpenCms user context.

I all use cases, the access to the OpenCms VFS is only possible with an initialized OpenCms user context, this means by using a CmsObject.

Since:

6.0.0

Version:

$Revision: 1.8 $

See Also:

OpenCmsServlet, CmsShell, OpenCms