org.opencms.main

Interface I_CmsResourceInit

All Known Implementing Classes:

CmsAliasResourceHandler, CmsDetailPageResourceHandler, CmsHistoryResourceHandler, CmsPermalinkResourceHandler, CmsUserTrackingResourceHandler, CmsWorkplaceLoginHandler

public interface 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).

Since:

6.0.0

Method Summary

Methods

Modifier and Type	Method and Description
CmsResource	initResource(CmsResource resource, CmsObject cms, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Possibility to modify or change the CmsFile with the CmsObject.

Method Detail

initResource

CmsResource initResource(CmsResource resource,
                       CmsObject cms,
                       javax.servlet.http.HttpServletRequest req,
                       javax.servlet.http.HttpServletResponse res)
                         throws CmsResourceInitException,
                                CmsSecurityException

Possibility to modify or change the CmsFile with the CmsObject.

Caution: reading parameters from the request, destroys special characters in all parameters, because the encoding for the request was not set yet.

Parameters:

resource - the requested file

cms - the current CmsObject

req - the current request

res - the current response

Returns:

a resource in the OpenCms VFS

Throws:

CmsResourceInitException - if other implementations of the interface should not be executed

CmsSecurityException - if other implementations of the interface should not be executed, and the security exception should be escalated