1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.rendering.transformation.linkchecker

File LinkContextDataProvider.java

 

Code metrics

0
0
0
1
47
8
0
-
-
0
-

Classes

Class Line # Actions
LinkContextDataProvider 39 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.rendering.transformation.linkchecker;
21   
22    import java.util.Map;
23   
24    import org.xwiki.component.annotation.Role;
25   
26    /**
27    * Allows implementation to provide data related to a Link. For example this can be used to add a HTTP Request URL
28    * so that when displaying the link status the user could see to what HTTP request it corresponds.
29    *
30    * <p>
31    * Note: Be careful not to implement heavy data in providers since they are stored in cache for all external links
32    * found and thus could lead to an Out Of Memory error if too large.
33    * </p>
34    *
35    * @version $Id: 8056c723295c30a4667af05258a40378dcbaea41 $
36    * @since 3.3RC1
37    */
38    @Role
 
39    public interface LinkContextDataProvider
40    {
41    /**
42    * @param linkURL the URL to the link being checked
43    * @param contentReference the reference to the source where the link was found
44    * @return the link context data to add to the link information
45    */
46    Map<String, Object> getContextData(String linkURL, String contentReference);
47    }