Package org.opencms.db

Class CmsUserTrackingResourceHandler

java.lang.Object

org.opencms.db.CmsUserTrackingResourceHandler

All Implemented Interfaces:

I_CmsResourceInit

public class CmsUserTrackingResourceHandler
extends java.lang.Object
implements I_CmsResourceInit

This resource handler checks if a resource has to be marked as visited by the current user. It checks the value of the usertracking.mark property.

Possible values are:

• online: The resource is marked only in the online project
• true: The resource is marked in all projects
• false: The resource is not marked at all

Since:

8.0

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	PROPERTY_USERTRACKING_MARK	Property that indicates if resources should be tracked, value has to be true, false or online.
static java.lang.String	VALUE_ONLINE	Constant for the property value online.

Constructor Summary

Constructors

Constructor	Description
CmsUserTrackingResourceHandler()

Method Summary

Modifier and Type	Method	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.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_USERTRACKING_MARK

public static final java.lang.String PROPERTY_USERTRACKING_MARK

Property that indicates if resources should be tracked, value has to be true, false or online.

See Also:

Constant Field Values

VALUE_ONLINE

public static final java.lang.String VALUE_ONLINE

Constant for the property value online.

See Also:

Constant Field Values

Constructor Detail

CmsUserTrackingResourceHandler

public CmsUserTrackingResourceHandler()

Method Detail

initResource

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

Description copied from interface: 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.

Specified by:

initResource in interface I_CmsResourceInit

Parameters:

resource - the requested file

cms - the current CmsObject

req - the current request

res - the current response

Returns:

a resource in the OpenCms VFS

See Also:

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