org.opencms.file.history

类 CmsHistoryResourceHandler

java.lang.Object

org.opencms.file.history.CmsHistoryResourceHandler

所有已实现的接口:

I_CmsResourceInit

public class CmsHistoryResourceHandler
extends java.lang.Object
implements I_CmsResourceInit

Resource init handler that loads historical versions of resources.

从以下版本开始:

6.9.1

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	ATTRIBUTE_NAME Constant for the historical version request attribute name.
static java.lang.String	HISTORY_HANDLER The historical version handler path.
static java.lang.String	PARAM_VERSION Request parameter name for the version number.
static int	PROJECT_OFFLINE_VERSION Constant for the offline project version.

构造器概要

构造器

构造器和说明
CmsHistoryResourceHandler()

方法概要

方法

限定符和类型	方法和说明
static I_CmsHistoryResource	getHistoryResource(javax.servlet.ServletRequest req) Returns the historical version of a resource, if the given request is displaying a history version.
static java.lang.String	getHistoryResourceURI(java.lang.String uri, javax.servlet.ServletRequest req) Appends the version parameter to the URI if needed.
static CmsResource	getResourceWithHistory(CmsObject cms, java.lang.String resourceUri) Returns the correct resource for the given URI, taken into account historical versions marked by the version parameter.
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.
static boolean	isHistoryRequest(javax.servlet.ServletRequest req) Returns true if the given request is displaying an historical version.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ATTRIBUTE_NAME

public static final java.lang.String ATTRIBUTE_NAME

Constant for the historical version request attribute name.

另请参阅:

常量字段值

HISTORY_HANDLER

public static final java.lang.String HISTORY_HANDLER

The historical version handler path.

另请参阅:

常量字段值

PARAM_VERSION

public static final java.lang.String PARAM_VERSION

Request parameter name for the version number.

另请参阅:

常量字段值

PROJECT_OFFLINE_VERSION

public static final int PROJECT_OFFLINE_VERSION

Constant for the offline project version.

另请参阅:

常量字段值

构造器详细资料

CmsHistoryResourceHandler

public CmsHistoryResourceHandler()

方法详细资料

getHistoryResource

public static I_CmsHistoryResource getHistoryResource(javax.servlet.ServletRequest req)

Returns the historical version of a resource, if the given request is displaying a history version.

参数:

req - the request to check

返回:

the historical resource if the given request is displaying an historical version

getHistoryResourceURI

public static java.lang.String getHistoryResourceURI(java.lang.String uri,
                                     javax.servlet.ServletRequest req)

Appends the version parameter to the URI if needed.

参数:

uri - the resource URI

req - the current request

返回:

the same URI, with additional parameters in case of a historical request

getResourceWithHistory

public static CmsResource getResourceWithHistory(CmsObject cms,
                                 java.lang.String resourceUri)
                                          throws CmsException

Returns the correct resource for the given URI, taken into account historical versions marked by the version parameter.

参数:

cms - the current CMS context

resourceUri - the resource URI

返回:

the resource, which can be an instance of I_CmsHistoryResource

抛出:

CmsException - if something goes wrong

isHistoryRequest

public static boolean isHistoryRequest(javax.servlet.ServletRequest req)

Returns true if the given request is displaying an historical version.

参数:

req - the request to check

返回:

true if the given request is displaying a historical version

initResource

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

从接口复制的说明: I_CmsResourceInit

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.

指定者:

initResource 在接口中 I_CmsResourceInit

参数:

resource - the requested file

cms - the current CmsObject

req - the current request

res - the current response

返回:

a resource in the OpenCms VFS

抛出:

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

另请参阅:

I_CmsResourceInit.initResource(org.opencms.file.CmsResource, org.opencms.file.CmsObject, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)