org.xwiki.rendering.transformation.linkchecker

Interface LinkContextDataProvider

@Role
public interface LinkContextDataProvider

Allows implementation to provide data related to a Link. For example this can be used to add a HTTP Request URL so that when displaying the link status the user could see to what HTTP request it corresponds.

Note: Be careful not to implement heavy data in providers since they are stored in cache for all external links found and thus could lead to an Out Of Memory error if too large.

Since:

3.3RC1

Version:

$Id: 8056c723295c30a4667af05258a40378dcbaea41 $

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getContextData(String linkURL, String contentReference)

Method Detail

getContextData

Map<String,Object> getContextData(String linkURL,
                                  String contentReference)

Parameters:

linkURL - the URL to the link being checked

contentReference - the reference to the source where the link was found

Returns:

the link context data to add to the link information