org.apache.maven.doxia.linkcheck.validation.HTTPLinkValidator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of doxia-linkcheck Show documentation

Doxia linkcheck is a tool to check the validity of links.

There is a newer version: 1.3.2

package org.apache.maven.doxia.linkcheck.validation;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import java.util.Locale;

/**
 * Checks links which are normal URLs.
 *
 * @author Ben Walding
 * @author Arnaud Heritier
 * @version $Id$
 */
public abstract class HTTPLinkValidator
    implements LinkValidator
{
    /** {@inheritDoc} */
    public Object getResourceKey( LinkValidationItem lvi )
    {
        String link = lvi.getLink();

        if ( !link.toLowerCase( Locale.ENGLISH ).startsWith( "http://" )
            && !link.toLowerCase( Locale.ENGLISH ).startsWith( "https://" ) && !link.startsWith( "/" ) )
        {
            return null;
        }

        int hashPos = link.indexOf( "#" );

        if ( hashPos != -1 )
        {
            link = link.substring( 0, hashPos );
        }

        return link;
    }

}