org.archive.modules.deciderules.SchemeNotInSetDecideRule Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of heritrix-modules Show documentation

This project contains some of the configurable modules used within the Heritrix application to crawl the web. The modules in this project can be used in applications other than Heritrix, however.

There is a newer version: 3.5.0

Show newest version

/*
 *  This file is part of the Heritrix web crawler (crawler.archive.org).
 *
 *  Licensed to the Internet Archive (IA) by one or more individual 
 *  contributors. 
 *
 *  The IA 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.
 */
package org.archive.modules.deciderules;

import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;

import org.archive.modules.CrawlURI;

/**
 * Rule applies the configured decision (default REJECT) for any URI which 
 * has a URI-scheme NOT contained in the configured Set. 
 *
 * @author gojomo
 */
public class SchemeNotInSetDecideRule extends PredicatedDecideRule {
    private static final long serialVersionUID = 3L;

    {
        setDecision(DecideResult.REJECT);
    }
    
    /**
     * Usual constructor.
     */
    public SchemeNotInSetDecideRule() {
    }
    
    /** set of schemes to test URI scheme */ 
    protected Set schemes = new HashSet(); 
    {
        // default set are those schemes Heritrix supports in usual configuration
        schemes.addAll(Arrays.asList(new String[] {"http","https","ftp","dns","whois"}));
    }
    public Set getSchemes() {
        return schemes;
    }
    public void setSchemes(Set schemes) {
        this.schemes = schemes;
    }

    /**
     * Evaluate whether given object is over the threshold number of
     * hops.
     */
    @Override
    protected boolean evaluate(CrawlURI uri) {
        return !schemes.contains(uri.getUURI().getScheme());
    }
}