org.opencms.relations

接口 I_CmsLinkParseable

所有已知实现类:

A_CmsResourceTypeLinkParseable, CmsResourceTypeJsp, CmsResourceTypeXmlAdeConfiguration, CmsResourceTypeXmlContainerPage, CmsResourceTypeXmlContent, CmsResourceTypeXmlPage

public interface I_CmsLinkParseable

This interface serves to retrieve all links from a given file by parsing.

Relation validation for a file is only enabled if the file's resource type implements this interface. so, files with resource types that do not implement this interface don't get validated for broken links, during publsihing, for instance.

This interface is used to build the internal relation information, but it is not directly used to validate the relations.

从以下版本开始:

6.3.0

方法概要

方法

限定符和类型	方法和说明
java.util.List<CmsLink>	parseLinks(CmsObject cms, CmsFile file) Returns a list of all links from the specified file.

方法详细资料

parseLinks

java.util.List<CmsLink> parseLinks(CmsObject cms,
                                 CmsFile file)

Returns a list of all links from the specified file.

Implementations of this method must return an empty list, or better Collections.EMPTY_LIST, if no link is found at all.

Implementations of this method should return the list of links including internal (OpenCms VFS) and external links (http, https, mailto, ftp, etc.).

参数:

cms - the current user's context

file - the file to be parsed

返回:

a list of CmsLink objects with the URIs of all linked resources