java.lang.Object
- org.opencms.main.OpenCmsCore

```
public final class OpenCmsCore
extends java.lang.Object
```
The internal implementation of the core OpenCms "operating system" functions.
All access to this class must be done through the public static methods of the OpenCms object. Under no circumstances should you ever try to access this class directly.
This class is so OpenCms internal you should not even be reading this documentation ;-)
Any request to the OpenCmsServlet will be forwarded to this core class. The core will then try to map the request to a VFS (Virtual File System) URI, that is a CmsResource in the OpenCms database. If a resource is found, it will be read and forwarded to to the corresponding I_CmsResourceLoader, which will then generate the output for the requested resource and return it to the requesting client.
There will be only one singleton instance of this object created for this core class. This means that in the default configuration, where OpenCms is accessed through a servlet context, there will be only one instance of the core in that servlet context.

Since:

6.0.0

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String PARAM_FORCE_ABSOLUTE_LINKS
Parameter to control whether generated links should always include the host.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`addRequestHandler(I_CmsRequestHandler handler)`	Adds the specified request handler to the Map of OpenCms request handlers.
`protected CmsADEManager`	`getADEManager()`	Gets the ADE manager, and makes sure it is initialized.
`protected CmsAliasManager`	`getAliasManager()`	Returns the alias manager.
`protected I_CmsApiAuthorizationHandler`	`getApiAuthorization(java.lang.String name)`	Gets the API authorization handler with the given name, or null if it doesn't exist.
`protected I_CmsAuthorizationHandler`	`getAuthorizationHandler()`	Returns the configured authorization handler.
`protected CmsConfigurationManager`	`getConfigurationManager()`	Returns the initialized OpenCms configuration manager.
`protected I_CmsCredentialsResolver`	`getCredentialsResolver()`	Gets the configured credentials resolver instance.
`protected java.util.List<java.lang.String>`	`getDbPoolNames()`	Gets the database pool names.
`protected java.util.List<java.lang.String>`	`getDefaultFiles()`	Returns the configured list of default directory file names.
`protected CmsDefaultUsers`	`getDefaultUsers()`	Returns the default user and group name configuration.
`protected CmsEventManager`	`getEventManager()`	Returns the OpenCms event manager.
`protected java.util.concurrent.ScheduledThreadPoolExecutor`	`getExecutor()`	Gets the thread pool executor.
`protected java.util.Set<CmsExportPoint>`	`getExportPoints()`	Returns the configured export points, the returned set being an unmodifiable set.
`protected CmsFlexCache`	`getFlexCache()`	Gets the flex cache.
`protected java.lang.String`	`getFlexCacheKeyDump()`	Gets a string containing all keys and variations currently in the flex cache, for debug purposes.
`protected CmsImportExportManager`	`getImportExportManager()`	Returns the initialized import/export manager, which contains information about the Cms import/export.
`protected static OpenCmsCore`	`getInstance()`	Returns the initialized OpenCms singleton instance.
`protected CmsLetsEncryptConfiguration`	`getLetsEncryptConfig()`	Gets the LetsEncrypt configuration.
`protected CmsLinkManager`	`getLinkManager()`	Returns the link manager to resolve links in <link> tags.
`protected CmsLocaleManager`	`getLocaleManager()`	Returns the locale manager used for obtaining the current locale.
`protected CmsLockManager`	`getLockManager()`	Returns the lock manager used for the locking mechanism.
`protected CmsLoginManager`	`getLoginManager()`	Returns the login manager used to check the validity of a login.
`protected CmsMemoryMonitor`	`getMemoryMonitor()`	Returns the memory monitor.
`protected CmsModuleManager`	`getModuleManager()`	Returns the module manager.
`protected CmsOrgUnitManager`	`getOrgUnitManager()`	Returns the organizational unit manager.
`protected I_CmsPasswordHandler`	`getPasswordHandler()`	Return the password handler.
`static java.lang.String`	`getPathInfo(javax.servlet.http.HttpServletRequest req)`	Returns the path for the request.
`protected CmsPublishManager`	`getPublishManager()`	Returns the publish manager instance.
`protected CmsRepositoryManager`	`getRepositoryManager()`	Returns the repository manager.
`protected I_CmsRequestHandler`	`getRequestHandler(java.lang.String name)`	Returns the handler instance for the specified name, or null if the name does not match any handler name.
`protected CmsResourceManager`	`getResourceManager()`	Returns the resource manager.
`protected CmsRoleManager`	`getRoleManager()`	Returns the role manager.
`protected int`	`getRunLevel()`	Returns the runlevel of this OpenCmsCore object instance.
`protected java.lang.Object`	`getRuntimeProperty(java.lang.Object key)`	Looks up a value in the runtime property Map.
`protected CmsScheduleManager`	`getScheduleManager()`	Returns the configured schedule manager.
`protected CmsSearchManager`	`getSearchManager()`	Returns the initialized search manager, which provides indexing and searching operations.
`protected CmsSecurityManager`	`getSecurityManager()`	Returns the initialized OpenCms security manager.
`protected CmsSessionManager`	`getSessionManager()`	Returns the session manager.
`protected CmsSiteManagerImpl`	`getSiteManager()`	Returns the initialized site manager, which contains information about all configured sites.
`protected CmsSqlManager`	`getSqlManager()`	Returns an instance of the common sql manager.
`protected CmsStaticExportManager`	`getStaticExportManager()`	Returns the properties for the static export.
`protected CmsSubscriptionManager`	`getSubscriptionManager()`	Returns the subscription manager.
`protected CmsSystemInfo`	`getSystemInfo()`	Returns the system information storage.
`protected CmsTemplateContextManager`	`getTemplateContextManager()`	Gets the template context manager instance.
`protected java.util.Map<java.lang.String,I_CmsTextEncryption>`	`getTextEncryptions()`	Gets the text encryptions.
`protected CmsThreadStore`	`getThreadStore()`	Returns the OpenCms Thread store.
`protected CmsTwoFactorAuthenticationHandler`	`getTwoFactorAuthenticationHandler()`	Gets the two-factor authentication handler.
`protected CmsUserDataRequestManager`	`getUserDataRequestManager()`	Gets the user data request manager.
`protected I_CmsValidationHandler`	`getValidationHandler()`	Returns the runtime validation handler.
`CmsVfsMemoryObjectCache`	`getVfsMemoryObjectCache()`	Gets the default CmsVfsMemoryCache instance.
`protected I_CmsWorkflowManager`	`getWorkflowManager()`	Returns the workflow manager instance.
`protected CmsWorkplaceAppManager`	`getWorkplaceAppManager()`	Returns the workplace app manager.
`protected CmsWorkplaceManager`	`getWorkplaceManager()`	Returns the initialized workplace manager, which contains information about the global workplace settings.
`protected CmsXmlContentTypeManager`	`getXmlContentTypeManager()`	Returns the XML content type manager.
`protected void`	`initCmsContextForUI(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, CmsUIServlet servlet)`	Initializes the OpenCms context for Vaadin UI servlet.
`protected CmsObject`	`initCmsObject(java.lang.String user)`	Returns an initialized CmsObject with the user initialized as provided, with the "Online" project selected and "/" set as the current site root.
`protected CmsObject`	`initCmsObject(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, boolean allowPrivilegedLogin)`	Handles the user authentification for each request sent to OpenCms.
`protected CmsObject`	`initCmsObject(CmsObject cms)`	Returns an independent copy of the provided CmsObject.
`protected CmsObject`	`initCmsObject(CmsObject adminCms, CmsContextInfo contextInfo)`	Returns an initialized CmsObject with the user and context initialized as provided.
`protected CmsObject`	`initCmsObjectFromSession(javax.servlet.http.HttpServletRequest req)`	Initializes a new cms object from the session data of the request.
`protected void`	`initConfiguration(CmsParameterConfiguration configuration)`	Constructor to create a new OpenCms object.
`protected void`	`initContext(javax.servlet.ServletContext context)`	Initialization of the OpenCms runtime environment.
`protected void`	`initMembers()`	Initialize member variables.
`protected CmsResource`	`initResource(CmsObject cms, java.lang.String resourceName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)`	Reads the requested resource from the OpenCms VFS, in case a directory name is requested, the default files of the directory will be looked up and the first match is returned.
`protected void`	`initServlet(OpenCmsServlet servlet)`	Initializes the system with the OpenCms servlet.
`protected void`	`invokeBuiltinService(java.lang.String remainingPath, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)`	Handler for built-in AJAX services that don't belong anywhere else and don't deserve their own request handler.
`protected void`	`invokeGwtService(java.lang.String serviceName, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletConfig servletConfig)`	Invokes the GWT servlet from within OpenCms.
`protected static void`	`setErrorCondition(CmsMessageContainer errorCondition)`	Sets the error condition.
`protected void`	`setRuntimeProperty(java.lang.Object key, java.lang.Object value)`	This method adds an Object to the OpenCms runtime properties.
`protected void`	`showResource(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)`	Displays a resource from the OpenCms by writing the result to the provided Servlet response output stream.
`protected void`	`shutDown()`	Destroys this OpenCms instance, called if the servlet (or shell) is shut down.
`protected CmsObject`	`updateContext(javax.servlet.http.HttpServletRequest request, CmsObject cms)`	This method updates the request context information.
`protected OpenCmsCore`	`upgradeRunlevel(javax.servlet.ServletContext context)`	Upgrades to runlevel `OpenCms.RUNLEVEL_4_SERVLET_ACCESS`, this is the final runlevel with an initialized database and Servlet context.
`protected OpenCmsCore`	`upgradeRunlevel(CmsParameterConfiguration configuration)`	Upgrades to runlevel `OpenCms.RUNLEVEL_3_SHELL_ACCESS`, this is shell access to the database but no Servlet context.
`protected void`	`writeConfiguration(java.lang.Class<?> clazz)`	Writes the XML configuration for the provided configuration class.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PARAM_FORCE_ABSOLUTE_LINKS
```
public static final java.lang.String PARAM_FORCE_ABSOLUTE_LINKS
```
    Parameter to control whether generated links should always include the host.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPathInfo
```
public static java.lang.String getPathInfo(javax.servlet.http.HttpServletRequest req)
```
    Returns the path for the request.
    First checks the HttpServletRequest.getPathInfo(), then the configured request error page attribute (if set), and then if still undefined the / is returned as path info.
    This is only needed when the HttpServletRequest.getPathInfo() is not really working as expected like in BEA WLS 9.x, where we have to use the 'weblogic.servlet.errorPage' request attribute.
    
    Parameters:
    
    req - the http request context
    
    Returns:
    
    the path for the request
  - getInstance
```
protected static OpenCmsCore getInstance()
```
    Returns the initialized OpenCms singleton instance.
    
    Returns:
    
    the initialized OpenCms singleton instance
  - setErrorCondition
```
protected static void setErrorCondition(CmsMessageContainer errorCondition)
```
    Sets the error condition.
    
    Parameters:
    
    errorCondition - the error condition to set
  - getVfsMemoryObjectCache
```
public CmsVfsMemoryObjectCache getVfsMemoryObjectCache()
```
    Gets the default CmsVfsMemoryCache instance.
    
    Returns:
    
    the default cache instance
  - addRequestHandler
```
protected void addRequestHandler(I_CmsRequestHandler handler)
```
    Adds the specified request handler to the Map of OpenCms request handlers.
    
    Parameters:
    
    handler - the handler to add
  - getADEManager
```
protected CmsADEManager getADEManager()
```
    Gets the ADE manager, and makes sure it is initialized.
    
    Returns:
    
    the initialized ADE manager
  - getAliasManager
```
protected CmsAliasManager getAliasManager()
```
    Returns the alias manager.
    
    Returns:
    
    the alias manager
  - getApiAuthorization
```
protected I_CmsApiAuthorizationHandler getApiAuthorization(java.lang.String name)
```
    Gets the API authorization handler with the given name, or null if it doesn't exist.
    
    Parameters:
    
    name - the name of the API authorization handler
    
    Returns:
    
    the API authorization handler, or null if it wasn't found
  - getAuthorizationHandler
```
protected I_CmsAuthorizationHandler getAuthorizationHandler()
```
    Returns the configured authorization handler.
    
    Returns:
    
    the configured authorization handler
  - getConfigurationManager
```
protected CmsConfigurationManager getConfigurationManager()
```
    Returns the initialized OpenCms configuration manager.
    
    Returns:
    
    the initialized OpenCms configuration manager
  - getCredentialsResolver
```
protected I_CmsCredentialsResolver getCredentialsResolver()
```
    Gets the configured credentials resolver instance.
    
    Returns:
    
    the credentials resolver
  - getDbPoolNames
```
protected java.util.List<java.lang.String> getDbPoolNames()
```
    Gets the database pool names.
    
    Returns:
    
    the configured database pool names
  - getDefaultFiles
```
protected java.util.List<java.lang.String> getDefaultFiles()
```
    Returns the configured list of default directory file names.
    
    Returns:
    
    the configured list of default directory file names
  - getDefaultUsers
```
protected CmsDefaultUsers getDefaultUsers()
```
    Returns the default user and group name configuration.
    
    Returns:
    
    the default user and group name configuration
  - getEventManager
```
protected CmsEventManager getEventManager()
```
    Returns the OpenCms event manager.
    
    Returns:
    
    the OpenCms event manager
  - getExecutor
```
protected java.util.concurrent.ScheduledThreadPoolExecutor getExecutor()
```
    Gets the thread pool executor.
    
    Returns:
    
    the thread pool executor
  - getExportPoints
```
protected java.util.Set<CmsExportPoint> getExportPoints()
```
    Returns the configured export points, the returned set being an unmodifiable set.
    
    Returns:
    
    an unmodifiable set of the configured export points
  - getFlexCache
```
protected CmsFlexCache getFlexCache()
```
    Gets the flex cache.
    
    Returns:
    
    CmsFlexCache
  - getFlexCacheKeyDump
```
protected java.lang.String getFlexCacheKeyDump()
```
    Gets a string containing all keys and variations currently in the flex cache, for debug purposes.
    
    Returns:
    
    a debug information string with the flex cache data
  - getImportExportManager
```
protected CmsImportExportManager getImportExportManager()
```
    Returns the initialized import/export manager, which contains information about the Cms import/export.
    
    Returns:
    
    the initialized import/export manager
  - getLetsEncryptConfig
```
protected CmsLetsEncryptConfiguration getLetsEncryptConfig()
```
    Gets the LetsEncrypt configuration.
    
    Returns:
    
    the LetsEncrypt configuration
  - getLinkManager
```
protected CmsLinkManager getLinkManager()
```
    Returns the link manager to resolve links in <link> tags.
    
    Returns:
    
    the link manager to resolve links in <link> tags
  - getLocaleManager
```
protected CmsLocaleManager getLocaleManager()
```
    Returns the locale manager used for obtaining the current locale.
    
    Returns:
    
    the locale manager
  - getLockManager
```
protected CmsLockManager getLockManager()
```
    Returns the lock manager used for the locking mechanism.
    
    Returns:
    
    the lock manager used for the locking mechanism
  - getLoginManager
```
protected CmsLoginManager getLoginManager()
```
    Returns the login manager used to check the validity of a login.
    
    Returns:
    
    the login manager
  - getMemoryMonitor
```
protected CmsMemoryMonitor getMemoryMonitor()
```
    Returns the memory monitor.
    
    Returns:
    
    the memory monitor
  - getModuleManager
```
protected CmsModuleManager getModuleManager()
```
    Returns the module manager.
    
    Returns:
    
    the module manager
  - getOrgUnitManager
```
protected CmsOrgUnitManager getOrgUnitManager()
```
    Returns the organizational unit manager.
    
    Returns:
    
    the organizational unit manager
  - getPasswordHandler
```
protected I_CmsPasswordHandler getPasswordHandler()
```
    Return the password handler.
    
    Returns:
    
    the password handler
  - getPublishManager
```
protected CmsPublishManager getPublishManager()
```
    Returns the publish manager instance.
    
    Returns:
    
    the publish manager instance
  - getRepositoryManager
```
protected CmsRepositoryManager getRepositoryManager()
```
    Returns the repository manager.
    
    Returns:
    
    the repository manager
  - getRequestHandler
```
protected I_CmsRequestHandler getRequestHandler(java.lang.String name)
```
    Returns the handler instance for the specified name, or null if the name does not match any handler name.
    
    Parameters:
    
    name - the name of the handler instance to return
    
    Returns:
    
    the handler instance for the specified name
  - getResourceManager
```
protected CmsResourceManager getResourceManager()
```
    Returns the resource manager.
    
    Returns:
    
    the resource manager
  - getRoleManager
```
protected CmsRoleManager getRoleManager()
```
    Returns the role manager.
    
    Returns:
    
    the role manager
  - getRunLevel
```
protected int getRunLevel()
```
    Returns the runlevel of this OpenCmsCore object instance.
    For a detailed description about the possible run levels, please see OpenCms.getRunLevel().
    
    Returns:
    
    the runlevel of this OpenCmsCore object instance
    
    See Also:
    
    OpenCms.getRunLevel()
  - getRuntimeProperty
```
protected java.lang.Object getRuntimeProperty(java.lang.Object key)
```
    Looks up a value in the runtime property Map.
    
    Parameters:
    
    key - the key to look up in the runtime properties
    
    Returns:
    
    the value for the key, or null if the key was not found
  - getScheduleManager
```
protected CmsScheduleManager getScheduleManager()
```
    Returns the configured schedule manager.
    
    Returns:
    
    the configured schedule manager
  - getSearchManager
```
protected CmsSearchManager getSearchManager()
```
    Returns the initialized search manager, which provides indexing and searching operations.
    
    Returns:
    
    the initialized search manager
  - getSecurityManager
```
protected CmsSecurityManager getSecurityManager()
```
    Returns the initialized OpenCms security manager.
    
    Returns:
    
    the initialized OpenCms security manager
  - getSessionManager
```
protected CmsSessionManager getSessionManager()
```
    Returns the session manager.
    
    Returns:
    
    the session manager
  - getSiteManager
```
protected CmsSiteManagerImpl getSiteManager()
```
    Returns the initialized site manager, which contains information about all configured sites.
    
    Returns:
    
    the initialized site manager
  - getSqlManager
```
protected CmsSqlManager getSqlManager()
```
    Returns an instance of the common sql manager.
    
    Returns:
    
    an instance of the common sql manager
  - getStaticExportManager
```
protected CmsStaticExportManager getStaticExportManager()
```
    Returns the properties for the static export.
    
    Returns:
    
    the properties for the static export
  - getSubscriptionManager
```
protected CmsSubscriptionManager getSubscriptionManager()
```
    Returns the subscription manager.
    
    Returns:
    
    the subscription manager
  - getSystemInfo
```
protected CmsSystemInfo getSystemInfo()
```
    Returns the system information storage.
    
    Returns:
    
    the system information storage
  - getTemplateContextManager
```
protected CmsTemplateContextManager getTemplateContextManager()
```
    Gets the template context manager instance.
    
    Returns:
    
    the template context manager instance
  - getTextEncryptions
```
protected java.util.Map<java.lang.String,I_CmsTextEncryption> getTextEncryptions()
```
    Gets the text encryptions.
    
    Returns:
    
    the text encryptions
  - getThreadStore
```
protected CmsThreadStore getThreadStore()
```
    Returns the OpenCms Thread store.
    
    Returns:
    
    the OpenCms Thread store
  - getTwoFactorAuthenticationHandler
```
protected CmsTwoFactorAuthenticationHandler getTwoFactorAuthenticationHandler()
```
    Gets the two-factor authentication handler.
    
    Returns:
    
    the two-factor authentication handler
  - getUserDataRequestManager
```
protected CmsUserDataRequestManager getUserDataRequestManager()
```
    Gets the user data request manager.
    
    Returns:
    
    the user data request manager
  - getValidationHandler
```
protected I_CmsValidationHandler getValidationHandler()
```
    Returns the runtime validation handler.
    
    Returns:
    
    the validation handler
  - getWorkflowManager
```
protected I_CmsWorkflowManager getWorkflowManager()
```
    Returns the workflow manager instance.
    
    Returns:
    
    the workflow manager
  - getWorkplaceAppManager
```
protected CmsWorkplaceAppManager getWorkplaceAppManager()
```
    Returns the workplace app manager.
    
    Returns:
    
    the workplace app manager
  - getWorkplaceManager
```
protected CmsWorkplaceManager getWorkplaceManager()
```
    Returns the initialized workplace manager, which contains information about the global workplace settings.
    
    Returns:
    
    the initialized workplace manager
  - getXmlContentTypeManager
```
protected CmsXmlContentTypeManager getXmlContentTypeManager()
```
    Returns the XML content type manager.
    
    Returns:
    
    the XML content type manager
  - initCmsContextForUI
```
protected void initCmsContextForUI(javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.http.HttpServletResponse res,
                                   CmsUIServlet servlet)
                            throws java.io.IOException,
                                   CmsException
```
    Initializes the OpenCms context for Vaadin UI servlet.
    
    Parameters:
    
    req - the request
    
    res - the response
    
    servlet - the UI servlet
    
    Throws:
    
    java.io.IOException - if user authentication fails
    
    CmsException - if something goes wrong
  - initCmsObject
```
protected CmsObject initCmsObject(CmsObject cms)
```
    Returns an independent copy of the provided CmsObject.
    This can be useful in case a permanent reference to a CmsObject is stored. Changing the request context values (for example project, siteroot) in the new CmsObject will have no side effects to the CmsObject it was copied form.
    The request time (CmsRequestContext.getRequestTime()) is set to the current time.
    
    Parameters:
    
    cms - the CmsObject to create a copy of
    
    Returns:
    
    an independent copy of the provided CmsObject
    
    Throws:
    
    CmsException - in case the initialization failed
    
    See Also:
    
    OpenCms.initCmsObject(CmsObject), OpenCms.initCmsObject(CmsObject, CmsContextInfo), OpenCms.initCmsObject(String)
  - initCmsObject
```
protected CmsObject initCmsObject(CmsObject adminCms,
                                  CmsContextInfo contextInfo)
                           throws CmsRoleViolationException,
                                  CmsException
```
    Returns an initialized CmsObject with the user and context initialized as provided.
    Note: Only if the provided adminCms CmsObject has admin permissions, this method allows the creation a CmsObject for any existing user. Otherwise only the default users 'Guest' and 'Export' can initialized with this method, all other user names will throw an Exception.
    
    Parameters:
    
    adminCms - must either be initialized with "Admin" permissions, or null
    
    contextInfo - the context info to create a CmsObject for
    
    Returns:
    
    an initialized CmsObject with the given users permissions
    
    Throws:
    
    CmsException - if an invalid user name was provided
    
    CmsRoleViolationException - if the current user does not have the role permissions to create a context for the requested user
    
    See Also:
    
    CmsDefaultUsers.getUserGuest(), CmsDefaultUsers.getUserExport(), OpenCms.initCmsObject(CmsObject), OpenCms.initCmsObject(CmsObject, CmsContextInfo), OpenCms.initCmsObject(String)
  - initCmsObject
```
protected CmsObject initCmsObject(javax.servlet.http.HttpServletRequest req,
                                  javax.servlet.http.HttpServletResponse res,
                                  boolean allowPrivilegedLogin)
                           throws java.io.IOException,
                                  CmsException
```
    Handles the user authentification for each request sent to OpenCms.
    User authentification is done in three steps:
    
    Session authentification: OpenCms stores information of all authentificated users in an internal storage based on the users session.
    
    Authorization handler authentification: If the session authentification fails, the current configured authorization handler is called.
    
    Default user: When both authentification methods fail, the user is set to the default (Guest) user.
    Parameters:
    
    req - the current http request
    
    res - the current http response
    
    allowPrivilegedLogin - true to allow login through authorization handlers
    
    Returns:
    
    the initialized cms context
    
    Throws:
    
    java.io.IOException - if user authentication fails
    
    CmsException - in case something goes wrong
  - initCmsObject
```
protected CmsObject initCmsObject(java.lang.String user)
                           throws CmsException
```
    Returns an initialized CmsObject with the user initialized as provided, with the "Online" project selected and "/" set as the current site root.
    Note: Only the default users 'Guest' and 'Export' can initialized with this method, all other user names will throw an Exception.
    
    Parameters:
    
    user - the user name to initialize, can only be CmsDefaultUsers.getUserGuest() or CmsDefaultUsers.getUserExport()
    
    Returns:
    
    an initialized CmsObject with the given users permissions
    
    Throws:
    
    CmsException - if an invalid user name was provided, or if something else goes wrong
    
    See Also:
    
    CmsDefaultUsers.getUserGuest(), CmsDefaultUsers.getUserExport(), OpenCms.initCmsObject(String), initCmsObject(CmsObject, CmsContextInfo)
  - initCmsObjectFromSession
```
protected CmsObject initCmsObjectFromSession(javax.servlet.http.HttpServletRequest req)
                                      throws CmsException
```
    Initializes a new cms object from the session data of the request.
    If no session data is found, null is returned.
    
    Parameters:
    
    req - the request
    
    Returns:
    
    the new initialized cms object
    
    Throws:
    
    CmsException - if something goes wrong
  - initConfiguration
```
protected void initConfiguration(CmsParameterConfiguration configuration)
                          throws CmsInitException
```
    Constructor to create a new OpenCms object.
    It reads the configurations from the opencms.properties file in the config/ subdirectory. With the information from this file is inits a ResourceBroker (Database access module), various caching systems and other options.
    This will only be done once per accessing class.
    
    Parameters:
    
    configuration - the configurations from the opencms.properties file
    
    Throws:
    
    CmsInitException - in case OpenCms can not be initialized
  - initContext
```
protected void initContext(javax.servlet.ServletContext context)
                    throws CmsInitException
```
    Initialization of the OpenCms runtime environment.
    The connection information for the database is read from the opencms.properties configuration file and all driver manager are initialized via the initializer, which usually will be an instance of a OpenCms class.
    
    Parameters:
    
    context - configuration of OpenCms from web.xml
    
    Throws:
    
    CmsInitException - in case OpenCms can not be initialized
  - initMembers
```
protected void initMembers()
```
    Initialize member variables.
  - initResource
```
protected CmsResource initResource(CmsObject cms,
                                   java.lang.String resourceName,
                                   javax.servlet.http.HttpServletRequest req,
                                   javax.servlet.http.HttpServletResponse res)
                            throws CmsException
```
    Reads the requested resource from the OpenCms VFS, in case a directory name is requested, the default files of the directory will be looked up and the first match is returned.
    The resource that is returned is always a CmsFile, even though the content will usually not be loaded in the result. Folders are never returned since the point of this method is really to load the default file if just a folder name is requested. If there is no default file in a folder, then the return value is null and no CmsException is thrown.
    The URI stored in the given OpenCms user context will be changed to the URI of the resource that was found and returned.
    Implementing and configuring an I_CmsResourceInit handler allows to customize the process of default resource selection.
    
    Parameters:
    
    cms - the current users OpenCms context
    
    resourceName - the path of the requested resource in the OpenCms VFS
    
    req - the current http request
    
    res - the current http response
    
    Returns:
    
    the requested resource read from the VFS
    
    Throws:
    
    CmsException - in case the requested file does not exist or the user has insufficient access permissions
    
    See Also:
    
    OpenCms.initResource(CmsObject, String, HttpServletRequest, HttpServletResponse)
  - initServlet
```
protected void initServlet(OpenCmsServlet servlet)
```
    Initializes the system with the OpenCms servlet.
    This is the final step that is called on the servlets "init()" method. It registers the servlets request handler and also outputs the final startup message. The servlet should auto-load since the <load-on-startup> parameter is set in the 'web.xml' by default.
    
    Parameters:
    
    servlet - the OpenCms servlet
  - invokeBuiltinService
```
protected void invokeBuiltinService(java.lang.String remainingPath,
                                    javax.servlet.http.HttpServletRequest req,
                                    javax.servlet.http.HttpServletResponse res)
                             throws javax.servlet.ServletException
```
    Handler for built-in AJAX services that don't belong anywhere else and don't deserve their own request handler.
    
    Parameters:
    
    remainingPath - the remainder of the path after /handleBuiltinService
    
    req - the current request
    
    res - the current response
    
    Throws:
    
    javax.servlet.ServletException - if something goes wrong
  - invokeGwtService
```
protected void invokeGwtService(java.lang.String serviceName,
                                javax.servlet.http.HttpServletRequest req,
                                javax.servlet.http.HttpServletResponse res,
                                javax.servlet.ServletConfig servletConfig)
```
    Invokes the GWT servlet from within OpenCms.
    
    Parameters:
    
    serviceName - the GWT PRC service class name
    
    req - the current servlet request
    
    res - the current servlet response
    
    servletConfig - the servlet configuration
  - setRuntimeProperty
```
protected void setRuntimeProperty(java.lang.Object key,
                                  java.lang.Object value)
```
    This method adds an Object to the OpenCms runtime properties. The runtime properties can be used to store Objects that are shared in the whole system.
    
    Parameters:
    
    key - the key to add the Object with
    
    value - the value of the Object to add
  - showResource
```
protected void showResource(javax.servlet.http.HttpServletRequest req,
                            javax.servlet.http.HttpServletResponse res)
```
    Displays a resource from the OpenCms by writing the result to the provided Servlet response output stream.
    
    Parameters:
    
    req - the current servlet request
    
    res - the current servlet response
  - shutDown
```
protected void shutDown()
```
    Destroys this OpenCms instance, called if the servlet (or shell) is shut down.
  - updateContext
```
protected CmsObject updateContext(javax.servlet.http.HttpServletRequest request,
                                  CmsObject cms)
                           throws CmsException
```
    This method updates the request context information.
    The update information is:
    
    Requested Url
    
    Locale
    
    Encoding
    
    Remote Address
    
    Request Time
    Parameters:
    
    request - the current request
    
    cms - the cms object to update the request context for
    
    Returns:
    
    a new updated cms context
    
    Throws:
    
    CmsException - if something goes wrong
  - upgradeRunlevel
```
protected OpenCmsCore upgradeRunlevel(CmsParameterConfiguration configuration)
                               throws CmsInitException
```
    Upgrades to runlevel OpenCms.RUNLEVEL_3_SHELL_ACCESS, this is shell access to the database but no Servlet context.
    To upgrade the runlevel, the system must be in runlevel OpenCms.RUNLEVEL_1_CORE_OBJECT, otherwise an exception is thrown.
    
    Parameters:
    
    configuration - the configuration
    
    Returns:
    
    the initialized OpenCmsCore
    
    Throws:
    
    CmsInitException - in case OpenCms can not be initialized
  - upgradeRunlevel
```
protected OpenCmsCore upgradeRunlevel(javax.servlet.ServletContext context)
                               throws CmsInitException
```
    Upgrades to runlevel OpenCms.RUNLEVEL_4_SERVLET_ACCESS, this is the final runlevel with an initialized database and Servlet context.
    To upgrade the runlevel, the system must be in runlevel OpenCms.RUNLEVEL_1_CORE_OBJECT, otherwise an exception is thrown.
    
    Parameters:
    
    context - the current servlet context
    
    Returns:
    
    the initialized OpenCmsCore
    
    Throws:
    
    CmsInitException - in case OpenCms can not be initialized
  - writeConfiguration
```
protected void writeConfiguration(java.lang.Class<?> clazz)
```
    Writes the XML configuration for the provided configuration class.
    
    Parameters:
    
    clazz - the configuration class to write the XML for

Class OpenCmsCore

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PARAM_FORCE_ABSOLUTE_LINKS

Method Detail

getPathInfo

getInstance

setErrorCondition

getVfsMemoryObjectCache

addRequestHandler

getADEManager

getAliasManager

getApiAuthorization

getAuthorizationHandler

getConfigurationManager

getCredentialsResolver

getDbPoolNames

getDefaultFiles

getDefaultUsers

getEventManager

getExecutor

getExportPoints

getFlexCache

getFlexCacheKeyDump

getImportExportManager

getLetsEncryptConfig

getLinkManager

getLocaleManager

getLockManager

getLoginManager

getMemoryMonitor

getModuleManager

getOrgUnitManager

getPasswordHandler

getPublishManager

getRepositoryManager

getRequestHandler

getResourceManager

getRoleManager

getRunLevel

getRuntimeProperty

getScheduleManager

getSearchManager

getSecurityManager

getSessionManager

getSiteManager

getSqlManager

getStaticExportManager

getSubscriptionManager

getSystemInfo

getTemplateContextManager

getTextEncryptions

getThreadStore

getTwoFactorAuthenticationHandler

getUserDataRequestManager

getValidationHandler

getWorkflowManager

getWorkplaceAppManager

getWorkplaceManager

getXmlContentTypeManager

initCmsContextForUI

initCmsObject

initCmsObject

initCmsObject

initCmsObject

initCmsObjectFromSession

initConfiguration

initContext

initMembers

initResource

initServlet

invokeBuiltinService

invokeGwtService

setRuntimeProperty

showResource

shutDown

updateContext

upgradeRunlevel