org.opencms.main

Class CmsPermalinkResourceHandler

java.lang.Object

org.opencms.main.CmsPermalinkResourceHandler

All Implemented Interfaces:

I_CmsResourceInit

public class CmsPermalinkResourceHandler
extends java.lang.Object
implements I_CmsResourceInit

Resource init handler that loads a resource given its permalink.

The permalink must have following format:
/${CONTEXT}/${SERVLET}/permalink/${UUID}.${EXT}

for example:
/opencms/opencms/permalink/a7b5d298-b3ab-11d8-b3e3-514d35713fed.html

Since:

6.3

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAPTURE_UUID_REGEX Regex for capturing a UUID.
static java.lang.String	PERMALINK_HANDLER The permalink handler path.
static java.lang.String	SUFFIX_REGEX Regex for the optional file extension.

Constructor Summary

Constructors

Constructor and Description
CmsPermalinkResourceHandler() Default constructor.

Method Summary

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.

Methods inherited from class java.lang.Object

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

Field Detail

CAPTURE_UUID_REGEX

public static final java.lang.String CAPTURE_UUID_REGEX

Regex for capturing a UUID.

See Also:

Constant Field Values

PERMALINK_HANDLER

public static final java.lang.String PERMALINK_HANDLER

The permalink handler path.

See Also:

Constant Field Values

SUFFIX_REGEX

public static final java.lang.String SUFFIX_REGEX

Regex for the optional file extension.

See Also:

Constant Field Values

Constructor Detail

CmsPermalinkResourceHandler

public CmsPermalinkResourceHandler()

Default constructor.

Method Detail

initResource

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

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

Throws:

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

CmsPermissionViolationException

See Also:

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