org.opencms.jsp

Most of the classes in this package implement the <cms:> taglib. To access the exact same functionality using scriptlets, obtain an instance of a {@link org.opencms.jsp.CmsJspActionElement} from the current JSP. Using the action element you can also access the current users OpenCms context in a {@link org.opencms.file.CmsObject}, by using {@link org.opencms.jsp.CmsJspBean#getCmsObject()}.

To aid in template navigation building, have a look at the {@link org.opencms.jsp.CmsJspNavBuilder} which provides a large selection of methods to easily create dynamic navigations.

@version $Revision: 1.10 $ @since 6.0.0 @see org.opencms.file.CmsObject @see org.opencms.file.types.CmsResourceTypeJsp @see org.opencms.loader.CmsJspLoader

If you have large chunks of code on your JSP that you want to move to a Class file, consider creating a subclass of this bean.

Use this together with the org.opencms.jsp.CmsJspActionElement to obtain navigation information based on the current users permissions. For example, use CmsJspNavBuilder.getNavigationForFolder(String) and pass the value of the current OpenCms user context uri obtained from org.opencms.file.CmsRequestContext.getUri as argument to obtain a list of all items in the navigation of the current folder.

Each navigation element contains a number of information about a VFS resource, obtained either from the resources properties or attributes.

The tag will create an instance of a CmsJspContentAccessBean that is stored in the selected context. Use the options provided by the bean to access the XML content directly.

For example together with the JSTL, use this tag inside an open tag like this:

 <cms:contentload ...

Since version 7.0.2 it is also possible to store the results of the content load in the JSP context using a CmsJspContentLoadBean .

This class is also used to generate the direct edit buttons for the <cms:include editable="..." /> and <cms:contentload editable="..." /> tags.

Since OpenCms version 6.2.3, the direct edit button HTML generated is controlled by an instance of I_CmsDirectEditProvider . The default direct edit provider used can be configured in opencms-workplace.xml in the <directeditprovider class="..." /> node.

Usually, if you want to create a JSP page using the OpenCms static export, some parts of the page should be processed by OpenCms, while other parts of the JSP are processed later when the exported JSP is deployed in another servlet container. A typical use case is that you have a template applied to the page in OpenCms, but the body content of the page is generated after the static export, for example by a database application.

Please note: In order to static export a JSP page with the ".jsp" suffix, you need to add the property "exportsuffix" with the value ".jsp" to the OpenCms JSP file in the VFS.

This tag supports the following special "property" values:

• opencms.version returns the current OpenCms version, e.g.

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.