All Packages from com.opencms.flex.cache.* to com.opencms.flex.util.*

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

•

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

Package Samples:

• com.opencms.flex.cache: Provides the JSP funtionality for OpenCms, with some additional utility functions.
• com.opencms.flex.util
• com.opencms.flex.jsp

Classes:

• CmsJspTagInfo: Provides access to OpenCms and System related information. This tag supports the following special "property" values: opencms.version returns the current OpenCms version, e.g. 5.0 Kaitain opencms.url returns the current request URL, e.g. http://localhost:8080/opencms/opencms/index.jsp opencms.uri returns the current request URI, e.g. /opencms/opencms/index.jsp opencms.webapp returns the name of the OpenCms web application, e.g. opencms opencms.webbasepath returns the name of system path to the OpenCms web application, e.g. C:\Java\Tomcat\webapps\opencms\ opencms.request.uri returns the name of ...
• CmsResourceTranslator: This class provides a resource name translation facility. Resource name translation is required for backward compatibility to the old OpenCms (pre 5.0 beta 2) directory layout. It can also be used to translate special characters or names automatically. It is also used for translating new resource names that contain illegal chars to legal names. This feature is most useful (and currently only used) for uploaded files. It is also applied to uploded ZIP directories that are extracted after upload. The translations can be configured in the opencms.properties. The default directory translation setting ...
• CmsJspTagProperty: Provides access to the properties of a resource in the OpenCms VFS . Of particular importance is the setting of the file attribute, which can take the following values. This attribute allows you to specify where to search for the property. The following values are supported: uri (default) Look up the property on the file with the uri requested by the user. search.uri or search Look up the property by also checking all parent folders for the property, starting with the file with uri requested by the user and going "upward" if the property was not found there. element.uri Look up the property on ...
• CmsFlexCache: This class implements the FlexCache. The data structure used is a two-level hashtable. This is optimized for the structure of the keys that are used to describe the caching behaviour of the entries. The first hash-level is calculated from the resource name, i.e. the name of the resource as it is referred to in the VFS of OpenCms. A suffix [online] or [offline] is appended to te resource name to distinguish between the online and offline projects of OpenCms. The second hash-level is calculated from the cache-key of the resource, which also is a String representing the specifc variation of the cached ...
• I_CmsResourceLoader: This interface describes a resource loader for OpenCms, a class that can load a resource from the VFS, process it's contents and deliver the result to the user. The I_CmsResourceLoader operates with Request and Response in much the same way as a standard Java web application. The I_CmsResourceLoader is closely related to the com.opencms.launcher.I_CmsLauncher interface. In essence, both interfaces serve the same purpose. However, the I_ResourceLoader is much closer related to the standard Java Servlet API then the I_CmsLauncher, which makes it easier to understand for the novice OpenCms programmer. ...
• CmsFlexLruCache: Implements an LRU (last recently used) cache. The idea of this cache to separate the caching policy from the data structure where the cached objects are stored. The advantage of doing so is, that the CmsFlexLruCache can identify the last-recently-used object in O(1), whereas you would need at least O(n) to traverse the data structure that stores the cached objects. Second, you can easily use the CmsFlexLruCache to get an LRU cache, no matter what data structure is used to store your objects. The cache policy is affected by the "costs" of the objects being cached. Valuable cache costs might be the ...
• I_CmsEventListener: Implement this interface in case your class has to react to CmsEvents that are thrown by system. In order to recieve system events, your class must register with the OpenCms event mechanism. This can be done in the constructor of a class like this: com.opencms.core.A_OpenCms.addCmsEventListener(this); A typical implementation might look like this: public void cmsEvent(com.opencms.flex.CmsEvent event) { switch (event.getType()) { case com.opencms.flex.I_CmsEventListener.EVENT_PUBLISH_PROJECT: case com.opencms.flex.I_CmsEventListener.EVENT_CLEAR_CACHES: // do something break; case com.opencms.flex.I_CmsEventListener.EVENT_LOGIN_USER: ...
• CmsFlexCacheEntry: Contains the contents of a cached resource. It is basically a list of pre-generated output, include() calls to other resources (with request parameters) and http headers that this resource requires to be set. A CmsFlexCacheEntry might also describe a redirect-call, but in this case nothing else will be cached. The pre-generated output is saved in byte[] arrays. The include() calls are saved as Strings of the included resource name, the parameters for the calls are saved in a HashMap. The headers are saved in a HashMap. In case of a redirect, the redircet target is cached in a String. The CmsFlexCacheEntry ...
• CmsJspActionElement: Bean to be used in JSP scriptlet code that provides direct access to the functionality offered by the opencms taglib. By instanciating a bean of this type and accessing the methods provided by the instance, all functionality of the OpenCms JSP taglib can be easily used from within JSP scriplet code, Initialize this bean at the beginning of your JSP like this: <jsp:useBean id="cms" class="com.opencms.flex.jsp.CmsJspActionElement"> &lt% cms.init(pageContext, request, response); %> </jsp:useBean> All exceptions that occur when calling any method of this class are catched and written ...
• CmsXmlTemplateLoader: Implementation of the I_CmsResourceLoader and the com.opencms.launcher.I_CmsLauncher interface for XMLTemplates. This implementation can deliver XMLTemplates directly since it extends the com.opencms.launcher.CmsXmlLauncher . It is also usable to include XMLTemplates as sub-elements on a JSP page since it implements the I_CmsResourceLoader interface.
• CmsUUID: Generates a UUID using spatial and temporal uniqueness. Spatial uniqueness is derived from ethernet address (MAC, 802.1); temporal from system clock. For more information about the algorith used, please see draft-leach-uuids-guids-01.txt . Because Java is unable to read the MAC address of the machine (without using JNI), the MAC address has to be provided first by using the static init(String) 55 method. This class is just a facade wrapper for the "real" UUID implementation.
• CmsMessages: Reads localized resource Strings from a java.util.ResourceBundle and provides convenience methods to access the Strings from a template. This class is to be used from JSP templates. Because of that, throwing of exceptions related to the access of the resource bundle are suppressed so that a template always execute. The class provides an isInitialized() 55 method that can be checked to see if the instance was properly initialized.
• CmsJspLoader: The JSP loader which enables the execution of JSP in OpenCms. It does NOT extend com.opencms.launcher.A_CmsLauncher , since JSP are not related to the OpenCms Template mechanism. However, it implements the launcher interface so that JSP can be sub-elements in XMLTemplace pages.
• CmsEvent: Event class for OpenCms for system wide events that are thrown by various operations (e.g. publishing) and can be catched and processed by classes that implement the I_CmsEventListener interface.
• CmsFlexRequestDispatcher: Implementation of the javax.servlet.RequestDispatcher interface to allow JSPs to be loaded from OpenCms. This dispatcher will load data from 3 different data sources: Form the "real" system Filesystem (e.g. for JSP pages) From the OpenCms VFS From the Flex cache
• I_CmsFlexLruCacheObject: Defines the methods which an object being cached by CmsFlexLruCache must implement. CmsFlexLruCache is organized as a double linked list, that's why objects implementing this interface need getters/setter for the next/previous nodes in the list of all cached objects.
• CmsFlexCacheKey: Implements the CmsFlexCacheKey, which is a key used to describe the caching behaviour of a specific resource. It has a lot of "public" variables (which isn't good style, I know) to avoid method calling overhead (a cache is about speed, isn't it :).
• CmsJspTagLabel: Provides access to the labels stored in the language files of the OpenCms workplace. Instead of using the XML based workplace tags one should consider using standard Java resource bundles to provide language independent implementations.
• CmsJspNavBuilder: Bean to provide a convenient way to build navigation structures based on CmsJspNavElement .
• CmsJspTagLink: Implements the <cms:link>[filename]</cms:link> tag to add OpenCms managed links to a JSP page, required for link management and the static export to work properly.
• CmsDumpLoader: Dump loader for binary or other unprocessed resource types. This loader is used to deliver static sub-elements of pages processed by other loaders.
• CmsFlexResponse: Wrapper class for a HttpServletResponse. This class wrapps the standard HttpServletResponse so that it's output can be delivered to the CmsFlexCache.
• CmsFlexRequest: Wrapper class for a HttpServletRequest. This class wrapps the standard HttpServletRequest so that it's output can be delivered to the CmsFlexCache.
• CmsLruHashMap: A hash table based implementation of the Map interface with limited size and a "last-recently-used" cache policy of the mapped key/values.

Home | Contact Us | Privacy Policy | Terms of Service