This is an automated email from the ASF dual-hosted git repository.
snagel pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nutch.git
The following commit(s) were added to refs/heads/master by this push:
new 6f4c80b7f NUTCH-2962 Update and complete package info of protocol
plugins
6f4c80b7f is described below
commit 6f4c80b7fca0f0236e079587212c2adcadba3a69
Author: Sebastian Nagel <sna...@apache.org>
AuthorDate: Mon Aug 15 16:29:34 2022 +0200
NUTCH-2962 Update and complete package info of protocol plugins
---
.../org/apache/nutch/protocol/http/api/package-info.java | 2 +-
.../org/apache/nutch/protocol/htmlunit/package-info.java | 8 +++++++-
.../org/apache/nutch/protocol/httpclient/package-info.java | 14 +++++++-------
.../interactiveselenium/handlers}/package-info.java | 6 ++++--
.../nutch/protocol/interactiveselenium/package-info.java | 5 ++++-
.../org/apache/nutch/protocol/okhttp/package-info.java | 4 +++-
.../org/apache/nutch/protocol/selenium/package-info.java | 5 ++++-
7 files changed, 30 insertions(+), 14 deletions(-)
diff --git
a/src/plugin/lib-http/src/java/org/apache/nutch/protocol/http/api/package-info.java
b/src/plugin/lib-http/src/java/org/apache/nutch/protocol/http/api/package-info.java
index a99b4bac7..8cacc3eef 100644
---
a/src/plugin/lib-http/src/java/org/apache/nutch/protocol/http/api/package-info.java
+++
b/src/plugin/lib-http/src/java/org/apache/nutch/protocol/http/api/package-info.java
@@ -17,6 +17,6 @@
/**
* Common API used by HTTP plugins ({@link org.apache.nutch.protocol.http
http},
- * {@link org.apache.nutch.protocol.httpclient httpclient})
+ * {@link org.apache.nutch.protocol.httpclient httpclient}, etc.)
*/
package org.apache.nutch.protocol.http.api;
diff --git
a/src/plugin/protocol-htmlunit/src/java/org/apache/nutch/protocol/htmlunit/package-info.java
b/src/plugin/protocol-htmlunit/src/java/org/apache/nutch/protocol/htmlunit/package-info.java
index bf4902c25..80fabce3b 100644
---
a/src/plugin/protocol-htmlunit/src/java/org/apache/nutch/protocol/htmlunit/package-info.java
+++
b/src/plugin/protocol-htmlunit/src/java/org/apache/nutch/protocol/htmlunit/package-info.java
@@ -15,5 +15,11 @@
* limitations under the License.
*/
-/** Protocol plugin which supports retrieving documents via the http
protocol.*/
+/**
+ * Protocol plugin which supports retrieving documents via HTTP/HTTPS using
+ * <a href="https://www.selenium.dev/";>Selenium</a> and the
+ * <a href="https://github.com/SeleniumHQ/htmlunit-driver";>HtmlUnitDriver web
+ * driver</a> for the for the
+ * <a href="https://htmlunit.sourceforge.io/";>HtmlUnit</a> headless browser.
+ */
package org.apache.nutch.protocol.htmlunit;
diff --git
a/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/package-info.java
b/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/package-info.java
index 251204485..e3c390355 100644
---
a/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/package-info.java
+++
b/src/plugin/protocol-httpclient/src/java/org/apache/nutch/protocol/httpclient/package-info.java
@@ -15,12 +15,12 @@
* limitations under the License.
*/
-/**
- * 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. It handles cookies within a single fetch
- * operation. This plugin is based on Jakarta Commons
- * HttpClient library.
+/**
+ * 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. It handles cookies within a single fetch
+ * operation and offers support for POST authentication via HTML forms. This
+ * plugin is based on the <a href="https://hc.apache.org/";>Apache
HttpClient</a>
+ * library.
*/
package org.apache.nutch.protocol.httpclient;
diff --git
a/src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
b/src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/handlers/package-info.java
similarity index 78%
copy from
src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
copy to
src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/handlers/package-info.java
index 7bdf14a75..407cb7fc8 100644
---
a/src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
+++
b/src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/handlers/package-info.java
@@ -16,6 +16,8 @@
*/
/**
- * Protocol plugin based on <a
href="https://github.com/square/okhttp";>okhttp</a>, supports http, https,
http/2.
+ * Handler implementations to interact with
+ * <a href="https://www.selenium.dev/";>Selenium</a> for
+ * {@link org.apache.nutch.protocol.interactiveselenium}.
*/
-package org.apache.nutch.protocol.okhttp;
+package org.apache.nutch.protocol.interactiveselenium.handlers;
diff --git
a/src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/package-info.java
b/src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/package-info.java
index f6738ed1d..bda9d69e0 100644
---
a/src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/package-info.java
+++
b/src/plugin/protocol-interactiveselenium/src/java/org/apache/nutch/protocol/interactiveselenium/package-info.java
@@ -15,5 +15,8 @@
* limitations under the License.
*/
-/** Protocol plugin which supports retrieving documents via selenium. */
+/**
+ * Protocol plugin which supports retrieving documents using and interacting
+ * with <a href="https://www.selenium.dev/";>Selenium</a>.
+ */
package org.apache.nutch.protocol.interactiveselenium;
diff --git
a/src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
b/src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
index 7bdf14a75..000b9881f 100644
---
a/src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
+++
b/src/plugin/protocol-okhttp/src/java/org/apache/nutch/protocol/okhttp/package-info.java
@@ -16,6 +16,8 @@
*/
/**
- * Protocol plugin based on <a
href="https://github.com/square/okhttp";>okhttp</a>, supports http, https,
http/2.
+ * Protocol plugin for HTTP/HTTPS based on
+ * <a href="https://github.com/square/okhttp";>okhttp</a>, supports HTTP 1.1
+ * and/or http/2.
*/
package org.apache.nutch.protocol.okhttp;
diff --git
a/src/plugin/protocol-selenium/src/java/org/apache/nutch/protocol/selenium/package-info.java
b/src/plugin/protocol-selenium/src/java/org/apache/nutch/protocol/selenium/package-info.java
index 2441aec1a..2f30743d2 100644
---
a/src/plugin/protocol-selenium/src/java/org/apache/nutch/protocol/selenium/package-info.java
+++
b/src/plugin/protocol-selenium/src/java/org/apache/nutch/protocol/selenium/package-info.java
@@ -15,5 +15,8 @@
* limitations under the License.
*/
-/** Protocol plugin which supports retrieving documents via selenium. */
+/**
+ * Protocol plugin which supports retrieving documents via
+ * <a href="https://www.selenium.dev/";>Selenium</a>.
+ */
package org.apache.nutch.protocol.selenium;
