Home >> All >> com >> opencms >> [ core Javadoc ]

•	com.opencms.core.exceptions.* (2)

• com.opencms.core: Javadoc index of package com.opencms.core.


Package Samples:

• com.opencms.core.exceptions: This package provides the classes used to access OpenCms resources by a servlet (or the OpenCms shell).  

Classes:

• OpenCmsHttpServlet: This the main servlet of the OpenCms system. From here, all other operations are invoked. Any incoming request is handled in multiple steps: The requesting user is authenticated and a CmsObject with the user information is created. The CmsObject is used to access all functions of OpenCms, limited by the authenticated users permissions. If the user is not identified, it is set to the default (guest) user. The requested document is loaded into OpenCms and depending on its type (and the users persmissions to display or modify it), it is send to one of the OpenCms launchers do be processed. The loaded ...
• CmsRequestHttpServlet: Implementation of the I_CmsRequest interface which wraps a HttpServletRequest and includes handling of multipart - requests. This implementation uses a HttpServletRequest as original request to create a CmsRequestHttpServlet. This either can be a normal HttpServletRequest or a CmsMultipartRequest which is used to upload file into the OpenCms. This class contains a modification of the MultipartRequest published in the O'Reilly book Java Servlet Programming by J. Junte, www.servlets.com It Constructs a new MultipartRequest to handle the specified request, saving any uploaded files to the given directory, ...
• OpenCms: This class is the main class of the OpenCms system, think of it as the "operating system" of OpenCms. Any request to an OpenCms resource will be processed by this class first. The class will try to map the request to a VFS (Virtual File System) resource, i.e. an URI. If the resource is found, it will be read anf forwarded to to a launcher, which is performs the output of the requested resource. The OpenCms class is independent of access module to the OpenCms (e.g. Servlet, Command Shell), therefore this class is not responsible for user authentification. This is done by the access module to the ...
• CmsCoreSession: This class implements a session storage which is mainly used to count the currently logged in OpenCms users. It is required for user authentification of OpenCms. For each active user, its name and other additional information (like the current user group) are stored in a hashtable, useing the session Id as key to them. When the session gets destroyed, the user will removed from the storage. One of the main purposes of this stored user session list is the sendBroadcastMessage() method.
• 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. Implementations of this interface use an existing response (e.g. HttpServletResponse) to initialize an I_CmsResponse.
• 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. Implementations of this interface use an existing request (e.g. HttpServletRequest) to initialize an I_CmsRequest.
• OpenCmsServletNotify: Implementation of the HttpSessionBindingListener interface. The OpenCmsServletNotify Object is notified when it is bound or unbound to a HTTPSession. It is required to inform the OpemCms that a session is destroyed and must be removed from the CmsCoreSession storage.
• CmsMultipartInputStreamHandler: A class to aid in reading multipart/form-data from a ServletInputStream. It keeps track of how many bytes have been read and detects when the Content-Length limit has been reached. This is necessary since some servlet engines are slow to notice the end of stream.
• CmsException: This class provides OpenCms interal Exception handling. A CmsExeption thrown will result in a default OpenCms error dialog box. Note: Most Exceptions thrown in templates and other classes will be converted to a CmsException by the template launcher.
• CmsSession: Implements the I_CmsSession interface and is required by the OpenCms session handling mechanism. This CmsSession object should be used instead of the HttpSession .
• CmsCheckResourceException: This exeption is thrown by a class which implements com.opencms.core.I_CmsCheckResource. When this exeption is thrown, all other implementations of I_CmsCheckResource will not be executed.
• 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.
• 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_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.
• CmsCronScheduler: This is the CronScheduler. It a deamon-thread that will be stopped after the system has stopped. It awaiks every minute and starts cronjobs at issue.
• CmsResponseHttpServlet: Implementation of the I_CmsResponse interface which wraps a HttpServletResponse and provides OpenCms with a facility to handle redirects.
• I_CmsConstants: This interface is a pool for constants in OpenCms. Other classes may implement this class to get easy access to this constants.
• CmsStaticExportProperties: This class provides a special data structure to access the static export properties read from opencms.properties .
• CmsExportResponse: Implementation of the I_CmsResponse interface which is used as response buffer for pages during a static export.
• CmsShell: This class is a commad line interface to OpenCms which can be used for the initial setup and to test the system.
• CmsShellCommands: This class is a commad line interface to OpenCms which can be used for the initial setup and to test the system.
• CmsExportRequest: Implementation of the I_CmsRequest interface which is used to request pages during a static export.
• CmsPlausibilizationException: This exception is thrown to signalize plausibilization errors in backoffice modules.
• I_CmsCronJob: This interface identifies an Object that can be started as a cronjob.
• CmsCronScheduleJobStarter: This class starts all needed jobs for the current time.

Home | Contact Us | Privacy Policy | Terms of Service