From 27bd913891db5df26f732ed35aaf7a235e6f9c6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Richard=20K=C3=B6rber?= Date: Sun, 30 Jul 2017 23:48:49 +0200 Subject: [PATCH] Checkstyle fixes --- .../acme4j/it/AbstractResponder.java | 3 ++- .../org/shredzone/acme4j/it/BammBamm.java | 19 ++++++++++++------- .../org/shredzone/acme4j/it/DnsHandler.java | 18 +++++++++++++++++- .../org/shredzone/acme4j/it/HttpHandler.java | 12 +++++++++++- .../shredzone/acme4j/it/TlsSniHandler.java | 12 +++++++++++- 5 files changed, 53 insertions(+), 11 deletions(-) diff --git a/acme4j-it/src/main/java/org/shredzone/acme4j/it/AbstractResponder.java b/acme4j-it/src/main/java/org/shredzone/acme4j/it/AbstractResponder.java index aa161273..b8618534 100644 --- a/acme4j-it/src/main/java/org/shredzone/acme4j/it/AbstractResponder.java +++ b/acme4j-it/src/main/java/org/shredzone/acme4j/it/AbstractResponder.java @@ -39,7 +39,8 @@ public abstract class AbstractResponder implements UriResponder { * @param session * {@link IHTTPSession} containing the decoding body parameters */ - public abstract void handle(Map urlParams, IHTTPSession session) throws Exception; + public abstract void handle(Map urlParams, IHTTPSession session) + throws Exception; //NOSONAR: the request fails on any exception @Override public Response post(UriResource uriResource, Map urlParams, IHTTPSession session) { diff --git a/acme4j-it/src/main/java/org/shredzone/acme4j/it/BammBamm.java b/acme4j-it/src/main/java/org/shredzone/acme4j/it/BammBamm.java index cc04fd8d..27af37dc 100644 --- a/acme4j-it/src/main/java/org/shredzone/acme4j/it/BammBamm.java +++ b/acme4j-it/src/main/java/org/shredzone/acme4j/it/BammBamm.java @@ -47,13 +47,6 @@ public class BammBamm { private final HttpServer httpServer; private final TlsSniServer tlsSniServer; - /** - * Retrieves the singleton instance of {@link BammBamm}. - */ - public static BammBamm instance() { - return INSTANCE; - } - private BammBamm() { ResourceBundle bundle = ResourceBundle.getBundle("bammbamm"); appPort = Integer.parseInt(bundle.getString("app.port")); @@ -67,6 +60,15 @@ public class BammBamm { appServer = new AppServer(appPort); } + /** + * Retrieves the singleton instance of {@link BammBamm}. + * + * @return {@link BammBamm} singleton instance + */ + public static BammBamm instance() { + return INSTANCE; + } + /** * Returns the {@link DnsServer} instance. */ @@ -140,6 +142,9 @@ public class BammBamm { /** * Start bammbamm. It runs until the Java process is stopped. + * + * @param args + * Command line arguments */ public static void main(String[] args) { BammBamm.instance().start(); diff --git a/acme4j-it/src/main/java/org/shredzone/acme4j/it/DnsHandler.java b/acme4j-it/src/main/java/org/shredzone/acme4j/it/DnsHandler.java index 59461baa..e509cd5d 100644 --- a/acme4j-it/src/main/java/org/shredzone/acme4j/it/DnsHandler.java +++ b/acme4j-it/src/main/java/org/shredzone/acme4j/it/DnsHandler.java @@ -23,13 +23,20 @@ import fi.iki.elonen.NanoHTTPD.IHTTPSession; /** * Request handler for all {@code dns-01} related requests. */ -public class DnsHandler { +public final class DnsHandler { public static final String ADD_A_RECORD = "/dns/add/a/:domain"; public static final String REMOVE_A_RECORD = "/dns/remove/a/:domain"; public static final String ADD_TXT_RECORD = "/dns/add/txt/:domain"; public static final String REMOVE_TXT_RECORD = "/dns/remove/txt/:domain"; + private DnsHandler() { + // this class cannot be instanciated. + } + + /** + * Adds an A Record. + */ public static class AddARecord extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { @@ -41,6 +48,9 @@ public class DnsHandler { } } + /** + * Removes an A Record. + */ public static class RemoveARecord extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { @@ -51,6 +61,9 @@ public class DnsHandler { } } + /** + * Adds a TXT Record. + */ public static class AddTxtRecord extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { @@ -62,6 +75,9 @@ public class DnsHandler { } } + /** + * Removes a TXT Record. + */ public static class RemoveTxtRecord extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { diff --git a/acme4j-it/src/main/java/org/shredzone/acme4j/it/HttpHandler.java b/acme4j-it/src/main/java/org/shredzone/acme4j/it/HttpHandler.java index 6bd64d20..70646552 100644 --- a/acme4j-it/src/main/java/org/shredzone/acme4j/it/HttpHandler.java +++ b/acme4j-it/src/main/java/org/shredzone/acme4j/it/HttpHandler.java @@ -22,11 +22,18 @@ import fi.iki.elonen.NanoHTTPD.IHTTPSession; /** * Request handler for all {@code http-01} related requests. */ -public class HttpHandler { +public final class HttpHandler { public static final String ADD = "/http/add/:token"; public static final String REMOVE = "/http/remove/:token"; + private HttpHandler() { + // this class cannot be instanciated. + } + + /** + * Adds a HTTP challenge. + */ public static class Add extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { @@ -38,6 +45,9 @@ public class HttpHandler { } } + /** + * Removes a HTTP challenge. + */ public static class Remove extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { diff --git a/acme4j-it/src/main/java/org/shredzone/acme4j/it/TlsSniHandler.java b/acme4j-it/src/main/java/org/shredzone/acme4j/it/TlsSniHandler.java index bb46b374..af54f800 100644 --- a/acme4j-it/src/main/java/org/shredzone/acme4j/it/TlsSniHandler.java +++ b/acme4j-it/src/main/java/org/shredzone/acme4j/it/TlsSniHandler.java @@ -30,11 +30,18 @@ import fi.iki.elonen.NanoHTTPD.IHTTPSession; /** * Request handler for all {@code tls-sni-02} related requests. */ -public class TlsSniHandler { +public final class TlsSniHandler { public static final String ADD = "/tlssni/add/:alias"; public static final String REMOVE = "/tlssni/remove/:alias"; + private TlsSniHandler() { + // this class cannot be instanciated. + } + + /** + * Adds an TLS-SNI certificate. + */ public static class Add extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception { @@ -57,6 +64,9 @@ public class TlsSniHandler { } } + /** + * Removes an TLS-SNI certificate. + */ public static class Remove extends AbstractResponder { @Override public void handle(Map urlParams, IHTTPSession session) throws Exception {