Package org.opencms.main

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

See Also:

OpenCmsServlet, CmsShell, OpenCms

Interface Summary

Interface	Description
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(CmsObject, String, HttpServletRequest, HttpServletResponse).
I_CmsSessionDestroyHandler	Interface used for notifying objects stored in a session when the session is destroyed.
I_CmsSessionStorageProvider	This interface is used to define the session storage implementation provider.
I_CmsShellCommands	Provides scriptable access to a class from the CmsShell.
I_CmsStartStopHandler	Interface for plugins that need to be called during startup and shutdown.
I_CmsThrowable	Provides localized Exception handling based on the OpenCms default locale.

Class Summary

Class	Description
A_CmsAuthorizationHandler	Abstract class to grant the needed access to the session manager.
CmsAliasResourceHandler	Resource init handler for detail-pages.
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.
CmsDefaultSessionStorageProvider	The default session storage provider implementation.
CmsDuplicateRemovingLogBuffer	Class used to collect log messages and later write them to the actual log but with duplicates removed.
CmsDuplicateRemovingLogBuffer.Entry	Entry to write to the log.
CmsEvent	Event class for OpenCms for system wide events that are thrown by various operations (e.g.
CmsEventManager	Manager that controls the OpenCms event system.
CmsExportExpiresFilter	Simple filter for setting caching headers for exported resources.
CmsHttpAuthenticationSettings	Contains the settings to handle HTTP basic authentication.
CmsLog	Provides the OpenCms logging mechanism.
CmsPermalinkResourceHandler	Resource init handler that loads a resource given its permalink.
CmsProtectedStaticFileHandler	Resource init handler that provides an alternative way of serving static files like images or binary files, using the API authorization mechanism instead of the normal authorization handler.
CmsServletContainerSettings	Stores specific servlet container options, that might influence OpenCms behavior.
CmsServletContainerSettings.CmsServletContainerCfgMode	Enumeration class for the configuration mode.
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 command line interface to access OpenCms functions which is used for the initial setup and also can be used for scripting access to the OpenCms repository without the Workplace.
CmsSingleThreadDumperThread	Profiling thread used for the startup process.
CmsSingleThreadDumperThread.SampleNode	Node for the summary tree generated from the thread dumps.
CmsStaticResourceHandler	Handles the requests for static resources located in the classpath.
CmsSystemInfo	Provides access to system wide "read only" information about the running OpenCms instance.
CmsThreadStore	The OpenCms "Grim Reaper" thread store were all system Threads are maintained.
CmsUIServlet	Servlet for workplace UI requests.
CmsVaadinServletService	A custom servlet service implementation.
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.
OpenCmsProtectedExportFilter	Filter access to statically exported resources while checking permissions.
OpenCmsServlet	This the main servlet of the OpenCms system.
OpenCmsServlet.RequestCache	Context class for storing request-dependent caches etc.
OpenCmsServlet.RequestInfo	Debugging information about currently running requests.
OpenCmsServletErrorHandler	This the error handler servlet of the OpenCms system.
OpenCmsSolrHandler	The OpenCms Solr handler.
OpenCmsSpellcheckHandler	Handles spell check requests.
OpenCmsUrlServletFilter	Implements a servlet filter for URL rewriting.

Enum Summary

Enum	Description
CmsBroadcast.ContentMode	The content mode describes how the text used for a broadcast message should be interpreted.

Exception Summary

Exception	Description
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.
CmsMultiException	A multi exception is a container for several exception messages that may be caused by an internal operation.
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.
CmsShellCommandException	Wrapper exception used to notify the shell that an error has occurred during execution of a shell command.