From 677197c4687b98e2c006b68900d1a4bbf500b9bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=CC=88rg=20Prante?= Date: Wed, 23 Nov 2016 17:11:40 +0100 Subject: [PATCH] fixes for sonarqube, add Closeable to API, remove unused classes --- build.gradle | 2 +- oai-client/config/checkstyle/checkstyle.xml | 2 +- .../org/xbib/oai/client/ClientOAIRequest.java | 2 +- .../xbib/oai/client/ClientOAIResponse.java | 2 +- .../org/xbib/oai/client/DefaultOAIClient.java | 15 ++++++------ .../{OAIClient.java => OAIClientMethods.java} | 15 ++++++------ .../oai/client/identify/IdentifyRequest.java | 2 +- .../oai/client/identify/IdentifyResponse.java | 6 ++--- .../ListIdentifiersRequest.java | 2 +- .../ListMetadataFormatsRequest.java | 2 +- .../listrecords/ListRecordsRequest.java | 6 +++-- .../listrecords/ListRecordsResponse.java | 12 +++++----- .../org/xbib/oai/client/ArxivClientTest.java | 4 +--- .../org/xbib/oai/client/DNBClientTest.java | 24 +++++++++---------- .../org/xbib/oai/client/DOAJClientTest.java | 6 ++--- .../org/xbib/oai/client/package-info.java | 2 +- oai-common/build.gradle | 2 +- oai-common/config/checkstyle/checkstyle.xml | 2 +- oai-server/config/checkstyle/checkstyle.xml | 2 +- 19 files changed, 52 insertions(+), 58 deletions(-) rename oai-client/src/main/java/org/xbib/oai/client/{OAIClient.java => OAIClientMethods.java} (93%) diff --git a/build.gradle b/build.gradle index 55d6b17..ba6e490 100644 --- a/build.gradle +++ b/build.gradle @@ -7,7 +7,7 @@ plugins { allprojects { group = 'org.xbib' - version = '1.0.1' + version = '1.0.2' apply plugin: 'java' apply plugin: 'maven' diff --git a/oai-client/config/checkstyle/checkstyle.xml b/oai-client/config/checkstyle/checkstyle.xml index 52fe33c..49a2bf2 100644 --- a/oai-client/config/checkstyle/checkstyle.xml +++ b/oai-client/config/checkstyle/checkstyle.xml @@ -56,7 +56,7 @@ page at http://checkstyle.sourceforge.net/config.html --> - + diff --git a/oai-client/src/main/java/org/xbib/oai/client/ClientOAIRequest.java b/oai-client/src/main/java/org/xbib/oai/client/ClientOAIRequest.java index 63571e7..3e06686 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/ClientOAIRequest.java +++ b/oai-client/src/main/java/org/xbib/oai/client/ClientOAIRequest.java @@ -15,7 +15,7 @@ import java.util.logging.Level; import java.util.logging.Logger; /** - * Client OAI request + * Client OAI request. */ public class ClientOAIRequest implements OAIRequest { diff --git a/oai-client/src/main/java/org/xbib/oai/client/ClientOAIResponse.java b/oai-client/src/main/java/org/xbib/oai/client/ClientOAIResponse.java index de4cdef..e3b6a35 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/ClientOAIResponse.java +++ b/oai-client/src/main/java/org/xbib/oai/client/ClientOAIResponse.java @@ -7,7 +7,7 @@ import java.io.IOException; import java.io.Writer; /** - * Default OAI response + * Default OAI response. */ public interface ClientOAIResponse extends OAIResponse { diff --git a/oai-client/src/main/java/org/xbib/oai/client/DefaultOAIClient.java b/oai-client/src/main/java/org/xbib/oai/client/DefaultOAIClient.java index 673b765..59c242e 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/DefaultOAIClient.java +++ b/oai-client/src/main/java/org/xbib/oai/client/DefaultOAIClient.java @@ -1,10 +1,5 @@ package org.xbib.oai.client; -import java.io.IOException; -import java.net.URISyntaxException; -import java.net.URL; -import java.time.Duration; - import org.xbib.helianthus.client.ClientBuilder; import org.xbib.helianthus.client.ClientFactory; import org.xbib.helianthus.client.http.HttpClient; @@ -16,10 +11,14 @@ import org.xbib.oai.client.listrecords.ListRecordsRequest; import org.xbib.oai.client.listsets.ListSetsRequest; import org.xbib.oai.util.ResumptionToken; +import java.net.URISyntaxException; +import java.net.URL; +import java.time.Duration; + /** - * Default OAI client + * Default OAI client. */ -public class DefaultOAIClient implements OAIClient { +public class DefaultOAIClient implements OAIClientMethods, AutoCloseable { private HttpClient client; @@ -185,7 +184,7 @@ public class DefaultOAIClient implements OAIClient { } @Override - public void close() throws IOException { + public void close() { // nothing to close } } diff --git a/oai-client/src/main/java/org/xbib/oai/client/OAIClient.java b/oai-client/src/main/java/org/xbib/oai/client/OAIClientMethods.java similarity index 93% rename from oai-client/src/main/java/org/xbib/oai/client/OAIClient.java rename to oai-client/src/main/java/org/xbib/oai/client/OAIClientMethods.java index 728f2f3..0018980 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/OAIClient.java +++ b/oai-client/src/main/java/org/xbib/oai/client/OAIClientMethods.java @@ -1,11 +1,7 @@ package org.xbib.oai.client; -import java.net.URISyntaxException; -import java.net.URL; - import org.xbib.helianthus.client.ClientFactory; import org.xbib.helianthus.client.http.HttpClient; -import org.xbib.oai.OAIConstants; import org.xbib.oai.client.getrecord.GetRecordRequest; import org.xbib.oai.client.identify.IdentifyRequest; import org.xbib.oai.client.listidentifiers.ListIdentifiersRequest; @@ -14,15 +10,18 @@ import org.xbib.oai.client.listrecords.ListRecordsRequest; import org.xbib.oai.client.listsets.ListSetsRequest; import org.xbib.oai.util.ResumptionToken; +import java.net.URISyntaxException; +import java.net.URL; + /** - * OAI client API + * OAI client API. * */ -public interface OAIClient extends OAIConstants, AutoCloseable { +public interface OAIClientMethods { - OAIClient setURL(URL uri, boolean trustAlways) throws URISyntaxException; + OAIClientMethods setURL(URL uri, boolean trustAlways) throws URISyntaxException; - OAIClient setURL(URL uri) throws URISyntaxException; + OAIClientMethods setURL(URL uri) throws URISyntaxException; URL getURL(); diff --git a/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyRequest.java b/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyRequest.java index 6f0d7ae..158bc19 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyRequest.java +++ b/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyRequest.java @@ -1,7 +1,7 @@ package org.xbib.oai.client.identify; -import org.xbib.oai.client.ClientOAIRequest; import org.xbib.oai.OAIRequest; +import org.xbib.oai.client.ClientOAIRequest; /** * diff --git a/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyResponse.java b/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyResponse.java index 7a2e20e..4c19673 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyResponse.java +++ b/oai-client/src/main/java/org/xbib/oai/client/identify/IdentifyResponse.java @@ -8,9 +8,6 @@ import org.xbib.oai.client.ClientOAIResponse; import org.xml.sax.InputSource; import org.xml.sax.SAXException; -import javax.xml.parsers.DocumentBuilder; -import javax.xml.parsers.DocumentBuilderFactory; -import javax.xml.parsers.ParserConfigurationException; import java.io.IOException; import java.io.StringReader; import java.io.Writer; @@ -18,6 +15,9 @@ import java.net.URL; import java.util.ArrayList; import java.util.Date; import java.util.List; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; /** * diff --git a/oai-client/src/main/java/org/xbib/oai/client/listidentifiers/ListIdentifiersRequest.java b/oai-client/src/main/java/org/xbib/oai/client/listidentifiers/ListIdentifiersRequest.java index 28b0a66..340ee9b 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/listidentifiers/ListIdentifiersRequest.java +++ b/oai-client/src/main/java/org/xbib/oai/client/listidentifiers/ListIdentifiersRequest.java @@ -1,7 +1,7 @@ package org.xbib.oai.client.listidentifiers; -import org.xbib.oai.client.ClientOAIRequest; import org.xbib.oai.OAIRequest; +import org.xbib.oai.client.ClientOAIRequest; /** * diff --git a/oai-client/src/main/java/org/xbib/oai/client/listmetadataformats/ListMetadataFormatsRequest.java b/oai-client/src/main/java/org/xbib/oai/client/listmetadataformats/ListMetadataFormatsRequest.java index 6007604..d0c70f8 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/listmetadataformats/ListMetadataFormatsRequest.java +++ b/oai-client/src/main/java/org/xbib/oai/client/listmetadataformats/ListMetadataFormatsRequest.java @@ -1,7 +1,7 @@ package org.xbib.oai.client.listmetadataformats; -import org.xbib.oai.client.ClientOAIRequest; import org.xbib.oai.OAIRequest; +import org.xbib.oai.client.ClientOAIRequest; /** * diff --git a/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsRequest.java b/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsRequest.java index 9069cc8..497d19c 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsRequest.java +++ b/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsRequest.java @@ -1,7 +1,7 @@ package org.xbib.oai.client.listrecords; -import org.xbib.oai.client.ClientOAIRequest; import org.xbib.oai.OAIConstants; +import org.xbib.oai.client.ClientOAIRequest; import org.xbib.oai.xml.MetadataHandler; import java.util.LinkedList; @@ -23,6 +23,8 @@ public class ListRecordsRequest extends ClientOAIRequest { return this; } - public List getHandlers() { return handlers; } + public List getHandlers() { + return handlers; + } } diff --git a/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsResponse.java b/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsResponse.java index 74d4b07..3274517 100644 --- a/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsResponse.java +++ b/oai-client/src/main/java/org/xbib/oai/client/listrecords/ListRecordsResponse.java @@ -13,12 +13,6 @@ import org.xbib.oai.exceptions.OAIException; import org.xbib.oai.util.ResumptionToken; import org.xml.sax.InputSource; -import javax.xml.transform.Source; -import javax.xml.transform.Transformer; -import javax.xml.transform.TransformerException; -import javax.xml.transform.TransformerFactory; -import javax.xml.transform.sax.SAXSource; -import javax.xml.transform.stream.StreamResult; import java.io.IOException; import java.io.StringReader; import java.io.Writer; @@ -28,6 +22,12 @@ import java.time.format.DateTimeFormatter; import java.time.temporal.ChronoUnit; import java.util.logging.Level; import java.util.logging.Logger; +import javax.xml.transform.Source; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.sax.SAXSource; +import javax.xml.transform.stream.StreamResult; /** * diff --git a/oai-client/src/test/java/org/xbib/oai/client/ArxivClientTest.java b/oai-client/src/test/java/org/xbib/oai/client/ArxivClientTest.java index 4c61614..f42aec4 100644 --- a/oai-client/src/test/java/org/xbib/oai/client/ArxivClientTest.java +++ b/oai-client/src/test/java/org/xbib/oai/client/ArxivClientTest.java @@ -39,8 +39,7 @@ public class ArxivClientTest { @Test public void testListRecordsArxiv() throws Exception { - try { - OAIClient client = new DefaultOAIClient().setURL(new URL("http://export.arxiv.org/oai2")); + try (DefaultOAIClient client = new DefaultOAIClient().setURL(new URL("http://export.arxiv.org/oai2"))) { IdentifyRequest identifyRequest = client.newIdentifyRequest(); HttpClient httpClient = client.getHttpClient(); AggregatedHttpMessage response = httpClient.execute(HttpHeaders.of(HttpMethod.GET, identifyRequest.getPath()) @@ -113,7 +112,6 @@ public class ArxivClientTest { } } fileWriter.close(); - client.close(); logger.info("count={}", count.get()); assertTrue(count.get() > 0L); } catch (ConnectException | ExecutionException e) { diff --git a/oai-client/src/test/java/org/xbib/oai/client/DNBClientTest.java b/oai-client/src/test/java/org/xbib/oai/client/DNBClientTest.java index deb5556..870dc0d 100644 --- a/oai-client/src/test/java/org/xbib/oai/client/DNBClientTest.java +++ b/oai-client/src/test/java/org/xbib/oai/client/DNBClientTest.java @@ -1,13 +1,6 @@ package org.xbib.oai.client; -import java.io.File; -import java.io.FileWriter; -import java.io.IOException; -import java.net.ConnectException; -import java.net.URL; -import java.time.Instant; -import java.util.concurrent.ExecutionException; -import java.util.concurrent.atomic.AtomicLong; +import static org.junit.Assert.assertEquals; import org.apache.logging.log4j.LogManager; import org.apache.logging.log4j.Logger; @@ -24,7 +17,14 @@ import org.xbib.oai.xml.SimpleMetadataHandler; import org.xml.sax.Attributes; import org.xml.sax.SAXException; -import static org.junit.Assert.assertEquals; +import java.io.File; +import java.io.FileWriter; +import java.io.IOException; +import java.net.ConnectException; +import java.net.URL; +import java.time.Instant; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.atomic.AtomicLong; /** * @@ -35,7 +35,7 @@ public class DNBClientTest { @Test public void testIdentify() throws Exception { - OAIClient client = new DefaultOAIClient().setURL(new URL("http://services.dnb.de/oai/repository")); + DefaultOAIClient client = new DefaultOAIClient().setURL(new URL("http://services.dnb.de/oai/repository")); IdentifyRequest request = client.newIdentifyRequest(); HttpClient httpClient = client.getHttpClient(); assertEquals("/oai/repository?verb=Identify", request.getPath()); @@ -45,8 +45,7 @@ public class DNBClientTest { @Test public void testListRecordsDNB() throws Exception { - try { - OAIClient client = new DefaultOAIClient().setURL(new URL("http://services.dnb.de/oai/repository")); + try (DefaultOAIClient client = new DefaultOAIClient().setURL(new URL("http://services.dnb.de/oai/repository"))){ ListRecordsRequest listRecordsRequest = client.newListRecordsRequest(); listRecordsRequest.setFrom(Instant.parse("2016-01-01T00:00:00Z")); listRecordsRequest.setUntil(Instant.parse("2016-01-10T00:00:00Z")); @@ -105,7 +104,6 @@ public class DNBClientTest { } } sw.close(); - client.close(); logger.info("count={}", count.get()); } catch (ConnectException | ExecutionException e) { logger.warn("skipped, can not connect"); diff --git a/oai-client/src/test/java/org/xbib/oai/client/DOAJClientTest.java b/oai-client/src/test/java/org/xbib/oai/client/DOAJClientTest.java index fccbbb7..bd86ca3 100644 --- a/oai-client/src/test/java/org/xbib/oai/client/DOAJClientTest.java +++ b/oai-client/src/test/java/org/xbib/oai/client/DOAJClientTest.java @@ -41,9 +41,8 @@ public class DOAJClientTest { @Test public void testListRecordsDOAJ() throws Exception { - try { - // will redirect to https://doaj.org/oai - OAIClient oaiClient = new DefaultOAIClient().setURL(new URL("http://doaj.org/oai"), true); + // will redirect to https://doaj.org/oai + try (DefaultOAIClient oaiClient = new DefaultOAIClient().setURL(new URL("http://doaj.org/oai"), true)) { IdentifyRequest identifyRequest = oaiClient.newIdentifyRequest(); HttpClient client = oaiClient.getHttpClient(); AggregatedHttpMessage response = client.execute(HttpHeaders.of(HttpMethod.GET, identifyRequest.getPath()) @@ -129,7 +128,6 @@ public class DOAJClientTest { } } fileWriter.close(); - oaiClient.close(); logger.info("count={}", count.get()); assertTrue(count.get() > 0L); } catch (ConnectException | ExecutionException e) { diff --git a/oai-client/src/test/java/org/xbib/oai/client/package-info.java b/oai-client/src/test/java/org/xbib/oai/client/package-info.java index 4203250..d0875c1 100644 --- a/oai-client/src/test/java/org/xbib/oai/client/package-info.java +++ b/oai-client/src/test/java/org/xbib/oai/client/package-info.java @@ -1,4 +1,4 @@ /** * Classes for testing OAI client. */ -package org.xbib.oai.client; \ No newline at end of file +package org.xbib.oai.client; diff --git a/oai-common/build.gradle b/oai-common/build.gradle index a7aea4c..d254a22 100644 --- a/oai-common/build.gradle +++ b/oai-common/build.gradle @@ -1,3 +1,3 @@ dependencies { - compile "org.xbib:content-rdf:1.0.4" + compile "org.xbib:content-rdf:1.0.5" } diff --git a/oai-common/config/checkstyle/checkstyle.xml b/oai-common/config/checkstyle/checkstyle.xml index 52fe33c..49a2bf2 100644 --- a/oai-common/config/checkstyle/checkstyle.xml +++ b/oai-common/config/checkstyle/checkstyle.xml @@ -56,7 +56,7 @@ page at http://checkstyle.sourceforge.net/config.html --> - + diff --git a/oai-server/config/checkstyle/checkstyle.xml b/oai-server/config/checkstyle/checkstyle.xml index 52fe33c..49a2bf2 100644 --- a/oai-server/config/checkstyle/checkstyle.xml +++ b/oai-server/config/checkstyle/checkstyle.xml @@ -56,7 +56,7 @@ page at http://checkstyle.sourceforge.net/config.html --> - +