CmsDefaultLinkSubstitutionHandler

java.lang.Object
- org.opencms.staticexport.CmsDefaultLinkSubstitutionHandler

所有已实现的接口:

I_CmsLinkSubstitutionHandler

直接已知子类:

CmsAdvancedLinkSubstitutionHandler
```
public class CmsDefaultLinkSubstitutionHandler
extends java.lang.Object
implements I_CmsLinkSubstitutionHandler
```
Default link substitution behavior.

从以下版本开始:

7.0.2

另请参阅:
for the method where this handler is used.

字段概要

字段
限定符和类型	字段和说明
`static java.lang.String`	`DONT_USE_CURRENT_SITE_FOR_WORKPLACE_REQUESTS` Key for a request context attribute to control whether the getRootPath method uses the current site root for workplace requests.

构造器概要

构造器
构造器和说明

CmsDefaultLinkSubstitutionHandler()

构造器
构造器和说明
`CmsDefaultLinkSubstitutionHandler()`

方法概要

方法
限定符和类型	方法和说明
`java.lang.String`	`getLink(CmsObject cms, java.lang.String link, java.lang.String siteRoot, boolean forceSecure)` Returns the resource root path in the OpenCms VFS for the given link, or `null` in case the link points to an external site.
`java.lang.String`	`getRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath)` Returns the resource root path in the OpenCms VFS for the given target URI link, or `null` in case the link points to an external site.
`protected java.lang.String`	`getSimpleRootPath(CmsObject cms, java.lang.String targetUri, java.lang.String basePath)` Gets the root path without taking into account detail page links.
`protected boolean`	`isDetailPageLinkSecure(CmsObject cms, java.lang.String detailPage, CmsResource detailContent, CmsSite targetSite, boolean secureRequest)` Checks whether a link to a detail page should be secure.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - DONT_USE_CURRENT_SITE_FOR_WORKPLACE_REQUESTS
```
public static final java.lang.String DONT_USE_CURRENT_SITE_FOR_WORKPLACE_REQUESTS
```
    Key for a request context attribute to control whether the getRootPath method uses the current site root for workplace requests. The getRootPath method clears this attribute when called.
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - CmsDefaultLinkSubstitutionHandler
```
public CmsDefaultLinkSubstitutionHandler()
```
- 方法详细资料
  - getLink
```
public java.lang.String getLink(CmsObject cms,
                       java.lang.String link,
                       java.lang.String siteRoot,
                       boolean forceSecure)
```
    Returns the resource root path in the OpenCms VFS for the given link, or null in case the link points to an external site.
    If the target URI contains no site information, but starts with the opencms context, the context is removed:
```
 /opencms/opencms/system/further_path -> /system/further_path
```
    If the target URI contains no site information, the path will be prefixed with the current site from the provided OpenCms user context:
```
 /folder/page.html -> /sites/mysite/folder/page.html
```
    If the path of the target URI is relative, i.e. does not start with "/", the path will be prefixed with the current site and the given relative path, then normalized. If no relative path is given, null is returned. If the normalized path is outsite a site, null is returned.
```
 page.html -> /sites/mysite/page.html
 ../page.html -> /sites/mysite/page.html
 ../../page.html -> null
```
    If the target URI contains a scheme/server name that denotes an opencms site, it is replaced by the appropriate site path:
```
 http://www.mysite.de/folder/page.html -> /sites/mysite/folder/page.html
```
    If the target URI contains a scheme/server name that does not match with any site, or if the URI is opaque or invalid, null is returned:
```
 http://www.elsewhere.com/page.html -> null
 mailto:someone@elsewhere.com -> null
```
    指定者:
    
    getLink 在接口中 I_CmsLinkSubstitutionHandler
    
    参数:
    cms - the current OpenCms user context
    link - the link to process which is assumed to point to a VFS resource, with optional parameters
    siteRoot - the site root of the link
    forceSecure - if true generates always an absolute URL (with protocol and server name) for secure links
    
    返回:
    a link from the URI stored in the provided OpenCms user context to the VFS resource indicated by the given link and siteRoot
    另请参阅:
    I_CmsLinkSubstitutionHandler.getLink(org.opencms.file.CmsObject, java.lang.String, java.lang.String, boolean)
  - getRootPath
```
public java.lang.String getRootPath(CmsObject cms,
                           java.lang.String targetUri,
                           java.lang.String basePath)
```
    从接口复制的说明: I_CmsLinkSubstitutionHandler
    Returns the resource root path in the OpenCms VFS for the given target URI link, or null in case the link points to an external site.
    The default implementation applies the following transformations to the link:
    - In case the link starts with a VFS prefix (for example /opencms/opencms, this prefix is removed from the result
    - In case the link is not a root path, the current site root is appended to the result.
    - In case the link is relative, it will be made absolute using the given absolute basePath as starting point.
    - In case the link contains a server schema (for example http://www.mysite.de/), which points to a configured site in OpenCms, the server schema is replaced with the root path of the site.
    - In case the link points to an external site, or in case it is not a valid URI, then null is returned.
    Please note the above text describes the default behavior as implemented by CmsDefaultLinkSubstitutionHandler, which can be fully customized using this handler interface.
    指定者:
    
    getRootPath 在接口中 I_CmsLinkSubstitutionHandler
    
    参数:
    cms - the current users OpenCms context
    targetUri - the target URI link
    basePath - path to use as base in case the target URI is relative (can be null)
    
    返回:
    the resource root path in the OpenCms VFS for the given target URI link, or null in case the link points to an external site
    另请参阅:
    I_CmsLinkSubstitutionHandler.getRootPath(org.opencms.file.CmsObject, java.lang.String, java.lang.String)
  - getSimpleRootPath
```
protected java.lang.String getSimpleRootPath(CmsObject cms,
                                 java.lang.String targetUri,
                                 java.lang.String basePath)
```
    Gets the root path without taking into account detail page links.
    
    参数:
    cms - - see the getRootPath() method
    targetUri - - see the getRootPath() method
    basePath - - see the getRootPath() method
    
    返回:
    - see the getRootPath() method
  - isDetailPageLinkSecure
```
protected boolean isDetailPageLinkSecure(CmsObject cms,
                             java.lang.String detailPage,
                             CmsResource detailContent,
                             CmsSite targetSite,
                             boolean secureRequest)
```
    Checks whether a link to a detail page should be secure.
    
    参数:
    cms - the current CMS context
    detailPage - the detail page path
    detailContent - the detail content resource
    targetSite - the target site containing the detail page
    secureRequest - true if the currently running request is secure
    
    返回:
    true if the link should be a secure link

类 CmsDefaultLinkSubstitutionHandler

字段概要

构造器概要

方法概要

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

字段详细资料

DONT_USE_CURRENT_SITE_FOR_WORKPLACE_REQUESTS

构造器详细资料

CmsDefaultLinkSubstitutionHandler

方法详细资料

getLink

getRootPath

getSimpleRootPath

isDetailPageLinkSecure