apache-nutch 1.23 API
Apache Nutch is a highly extensible and scalable open source web crawler software project.
Nutch is a project of the Apache Software Foundation and is part of the larger Apache community of developers and users.
Package
Description
Text document language identifier.
Subcollection is a subset of an index.
Crawl control code and tools to run the crawler.
Control code for exchange component, which acts in indexing job and decides to
which index writer a document should be routed, based on plugins behavior.
Plugin of Exchange component based on JEXL expressions.
The Nutch multi-threaded fetching module
Index content, configure and run indexing and cleaning jobs to
add, update, and delete documents from an index.
An indexing plugin for inbound anchor text.
Indexing filter to add document arbitrary data to the index
from the output of a user-specified class.
A basic indexing plugin, adds basic fields: url, host, title, content, etc.
Indexing filter to index meta data from RSS feeds.
This plugin implements an indexing filter which takes
advantage of the
GeoIP2-java API.
This plugin implements a dynamic indexing filter which uses JEXL
expressions to allow filtering based on the page's metadata
Indexing filter to add document metadata to the index.
A more indexing plugin, adds "more" index fields:last modified
date, MIME type, content length.
Indexing filter to allow pattern replacements on metadata.
A simple plugin called at indexing that adds fields with static data.
Indexing filter to assign documents to subcollections.
Top Level Domain Indexing plugin.
URL Meta Tag Indexing Plugin
Index writer plugin to write a plain CSV file.
Index writer plugin for debugging, writes pairs of <action, url> to a
text file, action is one of "add", "update", or "delete".
Index writer plugin for Elasticsearch.
Index writer plugin to produce JSON messages to Kafka.
Index writer plugin for OpenSearch.
Index writer plugin for Apache Solr.
A Multi-valued Metadata container, and set
of constant fields for Nutch Metadata.
Metrics infrastructure for Apache Nutch.
A microformats Rel-Tag
Parser/Indexer/Querier plugin.
Web-related interfaces: URL
filters
and normalizers.Helper classes related to the
Protocol
interface, see also org.apache.nutch.protocol.URL normalizer performing basic normalizations:
remove default ports, e.g., port 80 for
http:// URLs
remove needless slashes and dot segments in the path component
remove anchors
use percent-encoding (only) where needed
E.g.,
https://www.example.org/a/../b//./select%2Dlang.php?lang=español#anchor
is normalized to https://www.example.org/b/select-lang.php?lang=espa%C3%B1ol
Optional and configurable normalizations are:
convert Internationalized Domain Names (IDNs) uniquely either to the
ASCII (Punycode) or Unicode representation, see property
urlnormalizer.basic.host.idn
remove a trailing dot from host names, see property
urlnormalizer.basic.host.trim-trailing-dot
URL normalizer renaming hosts to a canonical form listed in the
configuration file.
URL normalizer dummy which does not change URLs.
URL normalizer to normalize the protocol for all URLs of a given host or
domain.
URL normalizer which sort the elements in the query part to avoid duplicates
by permutations.
URL normalizer with configurable rules based on regular expressions
(
Pattern).The
Parse interface and related classes.Parse wrapper to run external command to do the parsing.
Parse RSS feeds.
Parse filter to extract headings (h1, h2, etc.) from DOM parse tree.
An HTML document parsing plugin.
Parser and parse filter plugin to extract all (possible) links
from JavaScript files and embedded JavaScript code snippets.
Parse filter to extract meta tags: keywords, description, etc.
Parse various document formats with help of
Apache Tika.
Parse ZIP files: embedded files are recursively passed to appropriate parsers.
Adds serialized DOM to parse data, useful for debugging, to understand how
the parser implementation interprets a document (not only HTML).
Html Parse filter that classifies the outlinks from the parseresult as
relevant or irrelevant based on the parseText's relevancy (using a training
file where you can give positive and negative example texts see the
description of parsefilter.naivebayes.trainfile) and if found irrelevent
it gives the link a second chance if it contains any of the words from the
list given in parsefilter.naivebayes.wordlist.
RegexParseFilter.
The Nutch
Plugin System.Classes related to the
Protocol interface,
see also org.apache.nutch.net.protocols.Protocol plugin which supports retrieving local file resources.
Protocol plugin which supports retrieving documents via the ftp protocol.
Protocol plugin which supports retrieving documents via HTTP/HTTPS using
Selenium and the
HtmlUnitDriver web
driver for the for the
HtmlUnit headless browser.
Protocol plugin which supports retrieving documents via the http protocol.
Common API used by HTTP plugins (
http,
httpclient, etc.)Protocol plugin which supports retrieving documents via the HTTP andHTTPS
protocols, optionally with Basic, Digest and NTLM authentication schemes for
web server as well as proxy server.
Protocol plugin which supports retrieving documents using and interacting
with Selenium.
Handler implementations to interact with
Selenium for
org.apache.nutch.protocol.interactiveselenium.Protocol plugin for HTTP/HTTPS based on
okhttp, supports HTTP 1.1
and/or http/2.
Protocol plugin which supports retrieving documents via
Selenium.
Publisher package to implement queues
The
ScoringFilter interface.Scoring filter to stop crawling at a configurable depth
(number of "hops" from seed URLs).
Scoring filter used in conjunction with
WebGraph.Metadata Scoring Plugin
Scoring filter implementing a variant of the Online Page Importance Computation
(OPIC) algorithm.
Scoring filter to modify score or status of orphaned pages (no inlinks found
for a configurable amount of time).
Implements the cosine similarity metric for scoring relevant documents
Utility package for Lucene functions.
URL Meta Tag Scoring Plugin
A segment stores all data from on generate/fetch/update cycle:
fetch list, protocol status, raw content, parsed content, and extracted outgoing links.
Miscellaneous tools.
Tools to read the
Arc file format.
Tools to import / export between Nutch segments and
WARC archives.
Generic
URL filter library,
abstracting away from regular expression implementations.URL filter plugin based on
dk.brics.automaton Finite-State
Automata for JavaTM.
URL filter plugin to include only URLs which match an element in a given list of
domain suffixes, domain names, and/or host names.
URL filter plugin to exclude URLs by domain suffixes, domain names, and/or host names.
URL filter plugin that first does fast exact suffix matches on host/domain
names before applying regular expressions to the path component of a URL.
URL filter plugin which identifies exemptions to external urls when
when external urls are set to ignore.
URL filter plugin to include only URLs which match one of a given list of URL prefixes.
URL filter plugin to include and/or exclude URLs matching Java regular expressions.
URL filter plugin to either exclude or include only URLs which match
one of the given (path) suffixes.
URL filter plugin that validates given urls.
Miscellaneous utility classes.
Sample plugins that parse and index Creative Commons metadata.