1 package org.apache.maven.plugin.linkcheck.validation;
2
3 /* ====================================================================
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ====================================================================
19 */
20
21 /**
22 * @author <a href="mailto:bwalding@apache.org">Ben Walding</a>
23 * @author <a href="mailto:aheritier@apache.org">Arnaud Heritier</a>
24 * @version $Id: LinkValidator.java 532339 2007-04-25 12:28:56Z ltheussl $
25 */
26 public interface LinkValidator
27 {
28
29 /**
30 * If getResource(lvi) returned null, this will NOT be called.
31 *
32 * @param lvi
33 * @return int
34 * @throws Exception
35 */
36 public LinkValidationResult validateLink( LinkValidationItem lvi ) throws Exception;
37
38 /**
39 * The resource key is used by the cache to determine if it really needs to validate the link. No actual validation
40 * should be done at this point.
41 *
42 * @param lvi
43 * @return Object null if this validator should not be doing this work.
44 * @throws Exception
45 */
46 public Object getResourceKey( LinkValidationItem lvi );
47 }