org.opencms.relations
Interface I_CmsLinkParseable

All Known Implementing Classes:

A_CmsResourceTypeLinkParseable, CmsResourceTypeJsp, 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.

Since:

6.3.0

Version:

$Revision: 1.6 $

Author:

Michael Moossen

Method Summary

java.util.List

parseLinks(CmsObject cms, CmsFile file) Returns a list of all links from the specified file.

Method Detail

parseLinks

java.util.List 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.).

Parameters:

cms - the current user's context

file - the file to be parsed

Returns:

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