Package org.opencms.staticexport

Class CmsLocalePrefixLinkSubstitutionHandler

java.lang.Object

org.opencms.staticexport.CmsDefaultLinkSubstitutionHandler

org.opencms.staticexport.CmsLocalePrefixLinkSubstitutionHandler

All Implemented Interfaces:

I_CmsLinkSubstitutionHandler

public class CmsLocalePrefixLinkSubstitutionHandler
extends CmsDefaultLinkSubstitutionHandler

Link substitution handler required to render single tree localized sites.

Field Summary

Fields inherited from class org.opencms.staticexport.CmsDefaultLinkSubstitutionHandler

ATTR_IS_IMAGE_LINK, DONT_USE_CURRENT_SITE_FOR_WORKPLACE_REQUESTS, OVERRIDE_SITEROOT_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsLocalePrefixLinkSubstitutionHandler()

Method Summary

Modifier and Type	Method	Description
protected CmsPair<String,String>	addVfsPrefix(CmsObject cms, String vfsName, CmsSite targetSite, String parameters)	Adds the VFS prefix to the VFS name and potentially adjusts request parameters
protected String	generateCacheKey(CmsObject cms, String sourceSiteRoot, String targetSiteRoot, String detailPagePart, String absoluteLink)	Generates the cache key for Online links.
protected String	getRootPathForSite(CmsObject cms, String path, String siteRoot, boolean isRootPath)	Returns the root path for given site.
protected String	prepareExportParameters(CmsObject cms, String vfsName, String parameters)	Prepares the request parameters for the given resource.

Methods inherited from class org.opencms.staticexport.CmsDefaultLinkSubstitutionHandler

getLink, getLink, getRootPath, getSimpleRootPath, isDetailPageLinkSecure, isSecureLink

Methods inherited from class java.lang.Object

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

Constructor Details

CmsLocalePrefixLinkSubstitutionHandler

public CmsLocalePrefixLinkSubstitutionHandler()

Method Details

addVfsPrefix

protected CmsPair<String,String> addVfsPrefix(CmsObject cms,
 String vfsName,
 CmsSite targetSite,
 String parameters)

Description copied from class: CmsDefaultLinkSubstitutionHandler

Adds the VFS prefix to the VFS name and potentially adjusts request parameters

This method is required as a hook used in CmsLocalePrefixLinkSubstitutionHandler.

Overrides:

addVfsPrefix in class CmsDefaultLinkSubstitutionHandler

Parameters:

cms - the cms context

vfsName - the VFS name

targetSite - the target site

parameters - the request parameters

Returns:

the path and the (adjusted) request parameters.

See Also:

• CmsDefaultLinkSubstitutionHandler.addVfsPrefix(org.opencms.file.CmsObject, java.lang.String, org.opencms.site.CmsSite, java.lang.String)

generateCacheKey

protected String generateCacheKey(CmsObject cms,
 String sourceSiteRoot,
 String targetSiteRoot,
 String detailPagePart,
 String absoluteLink)

Description copied from class: CmsDefaultLinkSubstitutionHandler

Generates the cache key for Online links.

Overrides:

generateCacheKey in class CmsDefaultLinkSubstitutionHandler

Parameters:

cms - the current CmsObject

sourceSiteRoot - the source site root (where the content linked to is located)

targetSiteRoot - the target site root

detailPagePart - the detail page part

absoluteLink - the absolute (site-relative) link to the resource

Returns:

the cache key

See Also:

• CmsDefaultLinkSubstitutionHandler.generateCacheKey(org.opencms.file.CmsObject, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getRootPathForSite

protected String getRootPathForSite(CmsObject cms,
 String path,
 String siteRoot,
 boolean isRootPath)

Description copied from class: CmsDefaultLinkSubstitutionHandler

Returns the root path for given site.

This method is required as a hook used in CmsLocalePrefixLinkSubstitutionHandler.

Overrides:

getRootPathForSite in class CmsDefaultLinkSubstitutionHandler

Parameters:

cms - the cms context

path - the path

siteRoot - the site root, will be null in case of the root site

isRootPath - in case the path is already a root path

Returns:

the root path

See Also:

• CmsDefaultLinkSubstitutionHandler.getRootPathForSite(org.opencms.file.CmsObject, java.lang.String, java.lang.String, boolean)

prepareExportParameters

protected String prepareExportParameters(CmsObject cms,
 String vfsName,
 String parameters)

Description copied from class: CmsDefaultLinkSubstitutionHandler

Prepares the request parameters for the given resource.

This method is required as a hook used in CmsLocalePrefixLinkSubstitutionHandler.

Overrides:

prepareExportParameters in class CmsDefaultLinkSubstitutionHandler

Parameters:

cms - the cms context

vfsName - the vfs name

parameters - the parameters to prepare

Returns:

the root path

See Also:

• CmsDefaultLinkSubstitutionHandler.prepareExportParameters(org.opencms.file.CmsObject, java.lang.String, java.lang.String)