org.xwiki.rendering.internal.transformation.linkchecker.HTTPChecker Maven / Gradle / Ivy

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.rendering.internal.transformation.linkchecker;

import org.xwiki.component.annotation.Role;

/**
 * Verifies if a URL exists.
 *
 * @version $Id: 8519bc1ac2fc09fb666a0ba840dc4843f4669263 $
 * @since 3.3M1
 */
@Role
public interface HTTPChecker
{
    /**
     * @param url the URL to check
     * @return an HTTP response code (see http://en.wikipedia.org/wiki/List_of_HTTP_status_codes) or 0 if an error
     *         happened in the transport or if the passed URL is invalid
     */
    int check(String url);
}