summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarsten Loesing <karsten.loesing@gmx.net>2018-10-08 21:50:41 +0200
committerKarsten Loesing <karsten.loesing@gmx.net>2018-10-08 21:50:41 +0200
commit91c1f8605fb2b6291264a5badbd670e1176a718e (patch)
treeb17199955fe007c79d01bbb879a4525ce1a80cce
parent5ee2e0f91b6aec06ad8e157e63da972efb19f102 (diff)
squash! migrated all files and references from org/torproject/onionoo to org/torproject/metrics/onionoo; added package-info.java for all new packagestask-24295
- Tweak package-info comments. - Add change log entry. - Make some whitespace fixes.
-rw-r--r--CHANGELOG.md7
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/cron/package-info.java9
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/docs/package-info.java10
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/package-info.java9
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/server/package-info.java10
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/updater/package-info.java11
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/util/package-info.java11
-rw-r--r--src/main/java/org/torproject/metrics/onionoo/writer/package-info.java11
-rw-r--r--src/test/java/org/torproject/metrics/onionoo/server/ResourceServletTest.java32
9 files changed, 57 insertions, 53 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
index e41f8ba..b013d9e 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,10 @@
+# Changes in version 7.?-1.??.? - 2018-1?-??
+
+ * Minor changes
+ - Rename root package org.torproject.onionoo to
+ org.torproject.metrics.onionoo.
+
+
# Changes in version 7.0-1.18.1 - 2018-09-11
* Medium changes
diff --git a/src/main/java/org/torproject/metrics/onionoo/cron/package-info.java b/src/main/java/org/torproject/metrics/onionoo/cron/package-info.java
index 3523f3e..7e63cc1 100644
--- a/src/main/java/org/torproject/metrics/onionoo/cron/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/cron/package-info.java
@@ -1,8 +1,7 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Classes related to scheduled tasks, such as cron jobs
+ * Classes related to the background updater process.
*/
package org.torproject.metrics.onionoo.cron; \ No newline at end of file
diff --git a/src/main/java/org/torproject/metrics/onionoo/docs/package-info.java b/src/main/java/org/torproject/metrics/onionoo/docs/package-info.java
index 46be3c7..75ca580 100644
--- a/src/main/java/org/torproject/metrics/onionoo/docs/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/docs/package-info.java
@@ -1,8 +1,8 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Documents (a.k.a., REST Resources) managed by this service
+ * Documents managed by this service, including internal status files and
+ * pre-written response objects.
*/
package org.torproject.metrics.onionoo.docs; \ No newline at end of file
diff --git a/src/main/java/org/torproject/metrics/onionoo/package-info.java b/src/main/java/org/torproject/metrics/onionoo/package-info.java
index 49f63a3..b13453e 100644
--- a/src/main/java/org/torproject/metrics/onionoo/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/package-info.java
@@ -1,8 +1,7 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Root folder for the onionoo project
+ * Root package for this service.
*/
package org.torproject.metrics.onionoo; \ No newline at end of file
diff --git a/src/main/java/org/torproject/metrics/onionoo/server/package-info.java b/src/main/java/org/torproject/metrics/onionoo/server/package-info.java
index 9e00eac..9287320 100644
--- a/src/main/java/org/torproject/metrics/onionoo/server/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/server/package-info.java
@@ -1,8 +1,8 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Server classes that process client requests. The core of onionoo.
+ * Server classes that process client requests. The web-facing part of this
+ * service.
*/
package org.torproject.metrics.onionoo.server; \ No newline at end of file
diff --git a/src/main/java/org/torproject/metrics/onionoo/updater/package-info.java b/src/main/java/org/torproject/metrics/onionoo/updater/package-info.java
index 74fa93f..f630fa1 100644
--- a/src/main/java/org/torproject/metrics/onionoo/updater/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/updater/package-info.java
@@ -1,9 +1,8 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Classes related to the updater feature, which periodically updates internal files
- * related to status and metrics
+ * Classes related to the updater feature, which periodically updates internal
+ * files related to status and metrics.
*/
package org.torproject.metrics.onionoo.updater; \ No newline at end of file
diff --git a/src/main/java/org/torproject/metrics/onionoo/util/package-info.java b/src/main/java/org/torproject/metrics/onionoo/util/package-info.java
index 3b0484e..5deaab2 100644
--- a/src/main/java/org/torproject/metrics/onionoo/util/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/util/package-info.java
@@ -1,9 +1,8 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Generic utilities for aiding other classes. Feature-specific utility classes should be placed
- * in feature-specific packages
+ * Generic utilities for aiding other classes. Feature-specific utility classes
+ * should be placed in feature-specific packages.
*/
package org.torproject.metrics.onionoo.util; \ No newline at end of file
diff --git a/src/main/java/org/torproject/metrics/onionoo/writer/package-info.java b/src/main/java/org/torproject/metrics/onionoo/writer/package-info.java
index 56748e3..ed5ec44 100644
--- a/src/main/java/org/torproject/metrics/onionoo/writer/package-info.java
+++ b/src/main/java/org/torproject/metrics/onionoo/writer/package-info.java
@@ -1,9 +1,8 @@
-/*
- * Copyright 2018 The Tor Project
- * See LICENSE for licensing information
- */
+/* Copyright 2018 The Tor Project
+ * See LICENSE for licensing information */
+
/**
- * Classes responsible for building and sending Documents in response to client
- * requests
+ * Classes responsible for pre-building documents that can later be sent in
+ * response to client requests.
*/
package org.torproject.metrics.onionoo.writer; \ No newline at end of file
diff --git a/src/test/java/org/torproject/metrics/onionoo/server/ResourceServletTest.java b/src/test/java/org/torproject/metrics/onionoo/server/ResourceServletTest.java
index 8e4af5c..7c3c52e 100644
--- a/src/test/java/org/torproject/metrics/onionoo/server/ResourceServletTest.java
+++ b/src/test/java/org/torproject/metrics/onionoo/server/ResourceServletTest.java
@@ -38,7 +38,8 @@ public class ResourceServletTest {
private static ObjectMapper objectMapper = new ObjectMapper();
- private SortedMap<String, org.torproject.metrics.onionoo.docs.SummaryDocument> relays;
+ private SortedMap<String, org.torproject.metrics.onionoo.docs.SummaryDocument>
+ relays;
private SortedMap<String, org.torproject.metrics.onionoo.docs.SummaryDocument>
bridges;
@@ -153,9 +154,9 @@ public class ResourceServletTest {
this.relays.put("000C5F55BD4814B917CC474BD537F1A3B33CCE2A",
relayTorkaZ);
org.torproject.metrics.onionoo.docs.SummaryDocument relayFerrari458 =
- new org.torproject.metrics.onionoo.docs.SummaryDocument(true, "Ferrari458",
- "001C13B3A55A71B977CA65EC85539D79C653A3FC", Arrays.asList(
- "68.38.171.200", "[2001:4f8:3:2e::51]"),
+ new org.torproject.metrics.onionoo.docs.SummaryDocument(true,
+ "Ferrari458", "001C13B3A55A71B977CA65EC85539D79C653A3FC",
+ Arrays.asList("68.38.171.200", "[2001:4f8:3:2e::51]"),
DateTimeHelper.parse("2013-04-24 12:00:00"), true,
new TreeSet<>(Arrays.asList("Fast", "Named",
"Running", "V2Dir", "Valid")), 1140L, "us",
@@ -172,9 +173,9 @@ public class ResourceServletTest {
this.relays.put("001C13B3A55A71B977CA65EC85539D79C653A3FC",
relayFerrari458);
org.torproject.metrics.onionoo.docs.SummaryDocument relayTimMayTribute =
- new org.torproject.metrics.onionoo.docs.SummaryDocument(true, "TimMayTribute",
- "0025C136C1F3A9EEFE2AE3F918F03BFA21B5070B", Arrays.asList(
- "89.69.68.246"),
+ new org.torproject.metrics.onionoo.docs.SummaryDocument(true,
+ "TimMayTribute", "0025C136C1F3A9EEFE2AE3F918F03BFA21B5070B",
+ Arrays.asList("89.69.68.246"),
DateTimeHelper.parse("2013-04-22 20:00:00"), false,
new TreeSet<>(Arrays.asList("Fast",
"Running", "Unnamed", "V2Dir", "Valid")), 63L, "a1",
@@ -187,7 +188,8 @@ public class ResourceServletTest {
this.relays.put("0025C136C1F3A9EEFE2AE3F918F03BFA21B5070B",
relayTimMayTribute);
this.bridges = new TreeMap<>();
- org.torproject.metrics.onionoo.docs.SummaryDocument bridgeec2bridgercc7f31fe =
+ org.torproject.metrics.onionoo.docs.SummaryDocument
+ bridgeec2bridgercc7f31fe =
new org.torproject.metrics.onionoo.docs.SummaryDocument(false,
"ec2bridgercc7f31fe", "0000831B236DFF73D409AD17B40E2A728A53994F",
Arrays.asList("10.199.7.176"),
@@ -198,9 +200,9 @@ public class ResourceServletTest {
this.bridges.put("0000831B236DFF73D409AD17B40E2A728A53994F",
bridgeec2bridgercc7f31fe);
org.torproject.metrics.onionoo.docs.SummaryDocument bridgeUnnamed =
- new org.torproject.metrics.onionoo.docs.SummaryDocument(false, "Unnamed",
- "0002D9BDBBC230BD9C78FF502A16E0033EF87E0C", Arrays.asList(
- "10.0.52.84"),
+ new org.torproject.metrics.onionoo.docs.SummaryDocument(false,
+ "Unnamed", "0002D9BDBBC230BD9C78FF502A16E0033EF87E0C",
+ Arrays.asList("10.0.52.84"),
DateTimeHelper.parse("2013-04-20 17:37:04"), false,
new TreeSet<>(Arrays.asList("Valid")), -1L,
null, DateTimeHelper.parse("2013-04-14 07:07:05"), null, null, null,
@@ -236,12 +238,12 @@ public class ResourceServletTest {
UpdateStatus updateStatus = new UpdateStatus();
updateStatus.setUpdatedMillis(TEST_TIME);
documentStore.addDocument(updateStatus, null);
- for (Map.Entry<String, org.torproject.metrics.onionoo.docs.SummaryDocument> e :
- this.relays.entrySet()) {
+ for (Map.Entry<String, org.torproject.metrics.onionoo.docs.SummaryDocument>
+ e : this.relays.entrySet()) {
documentStore.addDocument(e.getValue(), e.getKey());
}
- for (Map.Entry<String, org.torproject.metrics.onionoo.docs.SummaryDocument> e :
- this.bridges.entrySet()) {
+ for (Map.Entry<String, org.torproject.metrics.onionoo.docs.SummaryDocument>
+ e : this.bridges.entrySet()) {
documentStore.addDocument(e.getValue(), e.getKey());
}
DocumentStoreFactory.setDocumentStore(documentStore);