From f91c5065fc88b8a0509a9401af59422fbae9544e Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Thu, 11 Aug 2022 21:50:02 +0200 Subject: [PATCH] Organize cert-d-java classes in packages --- .../java/pgp/cert_d/jdbc/sqlite/DatabaseSubkeyLookup.java | 2 +- .../main/java/pgp/cert_d/jdbc/sqlite/package-info.java | 2 +- .../main/java/pgp/cert_d/PGPCertificateDirectories.java | 3 +++ .../src/main/java/pgp/cert_d/PGPCertificateDirectory.java | 2 ++ .../java/pgp/cert_d/ReadOnlyPGPCertificateDirectory.java | 2 ++ .../java/pgp/cert_d/WritingPGPCertificateDirectory.java | 2 ++ .../FileBasedCertificateDirectoryBackend.java | 7 ++++++- .../InMemoryCertificateDirectoryBackend.java | 6 +++++- .../src/main/java/pgp/cert_d/backend/package-info.java | 8 ++++++++ .../java/pgp/cert_d/{ => exception}/BadDataException.java | 2 +- .../java/pgp/cert_d/{ => exception}/BadNameException.java | 2 +- .../pgp/cert_d/{ => exception}/NotAStoreException.java | 2 +- .../src/main/java/pgp/cert_d/exception/package-info.java | 8 ++++++++ .../cert_d/{ => subkey_lookup}/InMemorySubkeyLookup.java | 2 +- .../java/pgp/cert_d/{ => subkey_lookup}/SubkeyLookup.java | 2 +- .../main/java/pgp/cert_d/subkey_lookup/package-info.java | 8 ++++++++ .../java/pgp/certificate/KeyMaterialReaderBackend.java | 2 +- .../src/test/java/pgp/cert_d/FilenameResolverTest.java | 2 ++ .../src/test/java/pgp/cert_d/SubkeyLookupTest.java | 2 ++ 19 files changed, 56 insertions(+), 10 deletions(-) rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => backend}/FileBasedCertificateDirectoryBackend.java (98%) rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => backend}/InMemoryCertificateDirectoryBackend.java (94%) create mode 100644 pgp-cert-d-java/src/main/java/pgp/cert_d/backend/package-info.java rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => exception}/BadDataException.java (88%) rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => exception}/BadNameException.java (92%) rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => exception}/NotAStoreException.java (92%) create mode 100644 pgp-cert-d-java/src/main/java/pgp/cert_d/exception/package-info.java rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => subkey_lookup}/InMemorySubkeyLookup.java (97%) rename pgp-cert-d-java/src/main/java/pgp/cert_d/{ => subkey_lookup}/SubkeyLookup.java (96%) create mode 100644 pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/package-info.java diff --git a/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/DatabaseSubkeyLookup.java b/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/DatabaseSubkeyLookup.java index 5e3b58e..cc56b6d 100644 --- a/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/DatabaseSubkeyLookup.java +++ b/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/DatabaseSubkeyLookup.java @@ -11,7 +11,7 @@ import java.util.HashSet; import java.util.List; import java.util.Set; -import pgp.cert_d.SubkeyLookup; +import pgp.cert_d.subkey_lookup.SubkeyLookup; public class DatabaseSubkeyLookup implements SubkeyLookup { diff --git a/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/package-info.java b/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/package-info.java index 08114e4..74bf428 100644 --- a/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/package-info.java +++ b/pgp-cert-d-java-jdbc-sqlite-lookup/src/main/java/pgp/cert_d/jdbc/sqlite/package-info.java @@ -3,6 +3,6 @@ // SPDX-License-Identifier: Apache-2.0 /** - * Implementation of a {@link pgp.cert_d.SubkeyLookup} mechanism using an SQLite Database. + * Implementation of a {@link pgp.cert_d.subkey_lookup.SubkeyLookup} mechanism using an SQLite Database. */ package pgp.cert_d.jdbc.sqlite; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectories.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectories.java index de185b0..1dfeefb 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectories.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectories.java @@ -4,6 +4,9 @@ package pgp.cert_d; +import pgp.cert_d.backend.FileBasedCertificateDirectoryBackend; +import pgp.cert_d.backend.InMemoryCertificateDirectoryBackend; +import pgp.cert_d.exception.NotAStoreException; import pgp.certificate.KeyMaterialReaderBackend; import java.io.File; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectory.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectory.java index f3a753d..48de056 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectory.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/PGPCertificateDirectory.java @@ -4,6 +4,8 @@ package pgp.cert_d; +import pgp.cert_d.exception.BadDataException; +import pgp.cert_d.exception.BadNameException; import pgp.certificate.Certificate; import pgp.certificate.KeyMaterial; import pgp.certificate.KeyMaterialMerger; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/ReadOnlyPGPCertificateDirectory.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/ReadOnlyPGPCertificateDirectory.java index 03a563b..801179f 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/ReadOnlyPGPCertificateDirectory.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/ReadOnlyPGPCertificateDirectory.java @@ -4,6 +4,8 @@ package pgp.cert_d; +import pgp.cert_d.exception.BadDataException; +import pgp.cert_d.exception.BadNameException; import pgp.certificate.Certificate; import java.io.IOException; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/WritingPGPCertificateDirectory.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/WritingPGPCertificateDirectory.java index 57ce4c8..03f2c51 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/WritingPGPCertificateDirectory.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/WritingPGPCertificateDirectory.java @@ -4,6 +4,8 @@ package pgp.cert_d; +import pgp.cert_d.exception.BadDataException; +import pgp.cert_d.exception.BadNameException; import pgp.certificate.Certificate; import pgp.certificate.KeyMaterial; import pgp.certificate.KeyMaterialMerger; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/FileBasedCertificateDirectoryBackend.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/FileBasedCertificateDirectoryBackend.java similarity index 98% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/FileBasedCertificateDirectoryBackend.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/backend/FileBasedCertificateDirectoryBackend.java index 469457f..d802077 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/FileBasedCertificateDirectoryBackend.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/FileBasedCertificateDirectoryBackend.java @@ -2,8 +2,13 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.backend; +import pgp.cert_d.PGPCertificateDirectory; +import pgp.cert_d.SpecialNames; +import pgp.cert_d.exception.BadDataException; +import pgp.cert_d.exception.BadNameException; +import pgp.cert_d.exception.NotAStoreException; import pgp.certificate.Certificate; import pgp.certificate.KeyMaterial; import pgp.certificate.KeyMaterialMerger; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/InMemoryCertificateDirectoryBackend.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/InMemoryCertificateDirectoryBackend.java similarity index 94% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/InMemoryCertificateDirectoryBackend.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/backend/InMemoryCertificateDirectoryBackend.java index ff7c401..5fac78c 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/InMemoryCertificateDirectoryBackend.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/InMemoryCertificateDirectoryBackend.java @@ -2,8 +2,12 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.backend; +import pgp.cert_d.PGPCertificateDirectory; +import pgp.cert_d.SpecialNames; +import pgp.cert_d.exception.BadDataException; +import pgp.cert_d.exception.BadNameException; import pgp.certificate.Certificate; import pgp.certificate.KeyMaterial; import pgp.certificate.KeyMaterialMerger; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/package-info.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/package-info.java new file mode 100644 index 0000000..bf02c7c --- /dev/null +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/backend/package-info.java @@ -0,0 +1,8 @@ +// SPDX-FileCopyrightText: 2022 Paul Schaub +// +// SPDX-License-Identifier: Apache-2.0 + +/** + * Storage Backends. + */ +package pgp.cert_d.backend; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/BadDataException.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/BadDataException.java similarity index 88% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/BadDataException.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/exception/BadDataException.java index 6dbbcde..7dc8b7d 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/BadDataException.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/BadDataException.java @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.exception; /** * The data was not a valid OpenPGP cert or key in binary format. diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/BadNameException.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/BadNameException.java similarity index 92% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/BadNameException.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/exception/BadNameException.java index 4386506..510804e 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/BadNameException.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/BadNameException.java @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.exception; /** * Provided name was neither a valid fingerprint, nor a known special name. diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/NotAStoreException.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/NotAStoreException.java similarity index 92% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/NotAStoreException.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/exception/NotAStoreException.java index 4abd1f0..734de49 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/NotAStoreException.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/NotAStoreException.java @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.exception; /** * The base dir cannot possibly contain a store. diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/package-info.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/package-info.java new file mode 100644 index 0000000..b051b8b --- /dev/null +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/exception/package-info.java @@ -0,0 +1,8 @@ +// SPDX-FileCopyrightText: 2022 Paul Schaub +// +// SPDX-License-Identifier: Apache-2.0 + +/** + * Exceptions. + */ +package pgp.cert_d.exception; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/InMemorySubkeyLookup.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/InMemorySubkeyLookup.java similarity index 97% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/InMemorySubkeyLookup.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/InMemorySubkeyLookup.java index 400b0c1..a42f652 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/InMemorySubkeyLookup.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/InMemorySubkeyLookup.java @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.subkey_lookup; import java.util.Collections; import java.util.HashMap; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/SubkeyLookup.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/SubkeyLookup.java similarity index 96% rename from pgp-cert-d-java/src/main/java/pgp/cert_d/SubkeyLookup.java rename to pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/SubkeyLookup.java index 58101bd..05fe766 100644 --- a/pgp-cert-d-java/src/main/java/pgp/cert_d/SubkeyLookup.java +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/SubkeyLookup.java @@ -2,7 +2,7 @@ // // SPDX-License-Identifier: Apache-2.0 -package pgp.cert_d; +package pgp.cert_d.subkey_lookup; import java.io.IOException; import java.util.List; diff --git a/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/package-info.java b/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/package-info.java new file mode 100644 index 0000000..eb0a8b5 --- /dev/null +++ b/pgp-cert-d-java/src/main/java/pgp/cert_d/subkey_lookup/package-info.java @@ -0,0 +1,8 @@ +// SPDX-FileCopyrightText: 2022 Paul Schaub +// +// SPDX-License-Identifier: Apache-2.0 + +/** + * Subkey Lookup functionality. + */ +package pgp.cert_d.subkey_lookup; diff --git a/pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterialReaderBackend.java b/pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterialReaderBackend.java index b1996f9..2ee7972 100644 --- a/pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterialReaderBackend.java +++ b/pgp-cert-d-java/src/main/java/pgp/certificate/KeyMaterialReaderBackend.java @@ -4,7 +4,7 @@ package pgp.certificate; -import pgp.cert_d.BadDataException; +import pgp.cert_d.exception.BadDataException; import java.io.IOException; import java.io.InputStream; diff --git a/pgp-cert-d-java/src/test/java/pgp/cert_d/FilenameResolverTest.java b/pgp-cert-d-java/src/test/java/pgp/cert_d/FilenameResolverTest.java index 513bcad..8d94279 100644 --- a/pgp-cert-d-java/src/test/java/pgp/cert_d/FilenameResolverTest.java +++ b/pgp-cert-d-java/src/test/java/pgp/cert_d/FilenameResolverTest.java @@ -6,6 +6,8 @@ package pgp.cert_d; import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.Test; +import pgp.cert_d.backend.FileBasedCertificateDirectoryBackend; +import pgp.cert_d.exception.BadNameException; import java.io.File; import java.io.IOException; diff --git a/pgp-cert-d-java/src/test/java/pgp/cert_d/SubkeyLookupTest.java b/pgp-cert-d-java/src/test/java/pgp/cert_d/SubkeyLookupTest.java index 979f190..d05a149 100644 --- a/pgp-cert-d-java/src/test/java/pgp/cert_d/SubkeyLookupTest.java +++ b/pgp-cert-d-java/src/test/java/pgp/cert_d/SubkeyLookupTest.java @@ -24,6 +24,8 @@ import org.junit.jupiter.params.ParameterizedTest; import org.junit.jupiter.params.provider.MethodSource; import pgp.cert_d.jdbc.sqlite.DatabaseSubkeyLookup; import pgp.cert_d.jdbc.sqlite.SqliteSubkeyLookupDaoImpl; +import pgp.cert_d.subkey_lookup.InMemorySubkeyLookup; +import pgp.cert_d.subkey_lookup.SubkeyLookup; public class SubkeyLookupTest {