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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CmsPair<java.lang.String,java.lang.String>
addVfsPrefix(CmsObject cms, java.lang.String vfsName, CmsSite targetSite, java.lang.String parameters)
Adds the VFS prefix to the VFS name and potentially adjusts request parametersprotected java.lang.String
generateCacheKey(CmsObject cms, java.lang.String targetSiteRoot, java.lang.String detailPagePart, java.lang.String absoluteLink)
Generates the cache key for Online links.protected java.lang.String
getRootPathForSite(CmsObject cms, java.lang.String path, java.lang.String siteRoot, boolean isRootPath)
Returns the root path for given site.protected java.lang.String
prepareExportParameters(CmsObject cms, java.lang.String vfsName, java.lang.String parameters)
Prepares the request parameters for the given resource.-
Methods inherited from class org.opencms.staticexport.CmsDefaultLinkSubstitutionHandler
getLink, getLink, getRootPath, getSimpleRootPath, isDetailPageLinkSecure, isSecureLink
-
-
-
-
Constructor Detail
-
CmsLocalePrefixLinkSubstitutionHandler
public CmsLocalePrefixLinkSubstitutionHandler()
-
-
Method Detail
-
addVfsPrefix
protected CmsPair<java.lang.String,java.lang.String> addVfsPrefix(CmsObject cms, java.lang.String vfsName, CmsSite targetSite, java.lang.String parameters)
Description copied from class:CmsDefaultLinkSubstitutionHandler
Adds the VFS prefix to the VFS name and potentially adjusts request parametersThis method is required as a hook used in
CmsLocalePrefixLinkSubstitutionHandler
.- Overrides:
addVfsPrefix
in classCmsDefaultLinkSubstitutionHandler
- Parameters:
cms
- the cms contextvfsName
- the VFS nametargetSite
- the target siteparameters
- 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 java.lang.String generateCacheKey(CmsObject cms, java.lang.String targetSiteRoot, java.lang.String detailPagePart, java.lang.String absoluteLink)
Description copied from class:CmsDefaultLinkSubstitutionHandler
Generates the cache key for Online links.- Overrides:
generateCacheKey
in classCmsDefaultLinkSubstitutionHandler
- Parameters:
cms
- the current CmsObjecttargetSiteRoot
- the target site rootdetailPagePart
- the detail page partabsoluteLink
- 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)
-
getRootPathForSite
protected java.lang.String getRootPathForSite(CmsObject cms, java.lang.String path, java.lang.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 classCmsDefaultLinkSubstitutionHandler
- Parameters:
cms
- the cms contextpath
- the pathsiteRoot
- the site root, will be null in case of the root siteisRootPath
- 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 java.lang.String prepareExportParameters(CmsObject cms, java.lang.String vfsName, java.lang.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 classCmsDefaultLinkSubstitutionHandler
- Parameters:
cms
- the cms contextvfsName
- the vfs nameparameters
- the parameters to prepare- Returns:
- the root path
- See Also:
CmsDefaultLinkSubstitutionHandler.prepareExportParameters(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
-
-