Replaced WebClient with autogenerated Webclient

Author: JohannesRabauer

README.md

@@ -15,6 +15,9 @@ interface)](https://www.bzst.de/EN/Businesses/CESOP/electronic_data_transmission
 The BZSt (Bundeszentralamt für Steuern / Federal Central Tax Office) provides the Digital Inbox (DIP) as a service
 for payment service providers to transmit financial data.
 
+This library uses a [generated](./bzst-dip-java-client/pom.xml) client from an [``openapi.yml``](./openapi/openapi.yml)
+using [OpenAPI Generator](https://openapi-generator.tech/).
+
 Clients need to register / login
 at [BZSt online.portal](https://www.bzst.de/DE/Service/Portalinformation/Massendaten/DIP/dip.html?nn=68828)
 through [Elster](https://www.elster.de/elsterweb/start), [BundID](https://id.bund.de/de)

bzst-dip-java-client-demo/src/main/java/software/xdev/Application.java

@@ -9,7 +9,6 @@
 import org.slf4j.LoggerFactory;
 
 import software.xdev.bzst.dip.client.BzstDipClient;
-import software.xdev.bzst.dip.client.exception.HttpStatusCodeNotExceptedException;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipConfiguration;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipConfigurationBuilder;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipDpiMessageType;
@@ -35,7 +34,7 @@ public final class Application
 	private static final Logger LOGGER = LoggerFactory.getLogger(Application.class);
 
 	public static void main(final String[] args)
-		throws InterruptedException, HttpStatusCodeNotExceptedException, IOException
+		throws InterruptedException, IOException
 	{
 		final BzstDipConfiguration configuration = createConfiguration();
 		final BzstDipClient bzstDipClient = new BzstDipClient(configuration);

bzst-dip-java-client-demo/src/main/java/software/xdev/ApplicationWithConfigurationFromProperties.java

@@ -6,7 +6,6 @@
 import org.slf4j.LoggerFactory;
 
 import software.xdev.bzst.dip.client.BzstDipClient;
-import software.xdev.bzst.dip.client.exception.HttpStatusCodeNotExceptedException;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipConfiguration;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipConfigurationBuilder;
 import software.xdev.bzst.dip.client.model.configuration.PropertiesSupplier;
@@ -19,7 +18,7 @@ public final class ApplicationWithConfigurationFromProperties
 	private static final Logger LOGGER = LoggerFactory.getLogger(ApplicationWithConfigurationFromProperties.class);
 
 	public static void main(final String[] args)
-		throws InterruptedException, HttpStatusCodeNotExceptedException, IOException
+		throws InterruptedException, IOException
 	{
 		final BzstDipConfiguration configuration = createConfigurationFromProperties();
 		final BzstDipClient bzstDipClient = new BzstDipClient(configuration);

bzst-dip-java-client-demo/src/main/java/software/xdev/ApplicationWithCsvInput.java

@@ -10,7 +10,6 @@
 import org.slf4j.LoggerFactory;
 
 import software.xdev.bzst.dip.client.BzstDipClient;
-import software.xdev.bzst.dip.client.exception.HttpStatusCodeNotExceptedException;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipConfiguration;
 import software.xdev.bzst.dip.client.model.message.BzstDipCompleteResult;
 
@@ -21,7 +20,7 @@ public final class ApplicationWithCsvInput
 	private static final Logger LOGGER = LoggerFactory.getLogger(ApplicationWithCsvInput.class);
 
 	public static void main(final String[] args)
-		throws InterruptedException, HttpStatusCodeNotExceptedException, IOException
+		throws InterruptedException, IOException
 	{
 		final BzstDipConfiguration configuration = Application.createConfiguration();
 

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/BzstDipClient.java

@@ -21,7 +21,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import software.xdev.bzst.dip.client.exception.HttpStatusCodeNotExceptedException;
+import software.xdev.bzst.dip.client.generated.api.MdEinreichenProviderApi;
+import software.xdev.bzst.dip.client.generated.client.ApiClient;
 import software.xdev.bzst.dip.client.model.configuration.BzstDipConfiguration;
 import software.xdev.bzst.dip.client.model.message.BzstDipCompleteResult;
 import software.xdev.bzst.dip.client.model.message.BzstDipMessage;
@@ -45,10 +46,29 @@ public class BzstDipClient
 {
 	private static final Logger LOGGER = LoggerFactory.getLogger(BzstDipClient.class);
 	private final BzstDipConfiguration configuration;
+	private final WebClient webClient;
 
 	public BzstDipClient(final BzstDipConfiguration configuration)
+	{
+		this(configuration, new WebClient(configuration));
+	}
+	
+	public BzstDipClient(final BzstDipConfiguration configuration, final ApiClient apiClient)
+	{
+		this(configuration, new WebClient(configuration, apiClient));
+	}
+	
+	public BzstDipClient(
+		final BzstDipConfiguration configuration,
+		final MdEinreichenProviderApi mdEinreichenProviderApi)
+	{
+		this(configuration, new WebClient(configuration, mdEinreichenProviderApi));
+	}
+	
+	public BzstDipClient(final BzstDipConfiguration configuration, final WebClient webClient)
 	{
 		this.configuration = configuration;
+		this.webClient = webClient;
 	}
 
 	/**
@@ -60,7 +80,6 @@ public BzstDipClient(final BzstDipConfiguration configuration)
 	 * @return the result which only contains the dataTransferNumber
 	 */
 	public BzstDipSendingResult sendDipOnly(final BzstDipMessage message)
-		throws HttpStatusCodeNotExceptedException
 	{
 		return this.sendDipOnly(message.toXmlType(this.configuration));
 	}
@@ -73,7 +92,6 @@ public BzstDipSendingResult sendDipOnly(final BzstDipMessage message)
 	 * @return the result which only contains the dataTransferNumber
 	 */
 	public BzstDipSendingResult sendDipOnly(final String csvData)
-		throws HttpStatusCodeNotExceptedException
 	{
 		return this.sendDipOnly(ReportableSellerCsvFileParser.parseCsvData(csvData, this.configuration));
 	}
@@ -87,7 +105,6 @@ public BzstDipSendingResult sendDipOnly(final String csvData)
 	 */
 	public BzstDipSendingResult sendDipOnly(
 		final List<CorrectableReportableSellerType> correctableReportableSellerTypes)
-		throws HttpStatusCodeNotExceptedException
 	{
 		return this.sendDipOnly(
 			correctableReportableSellerTypes,
@@ -107,19 +124,15 @@ public BzstDipSendingResult sendDipOnly(
 	public BzstDipSendingResult sendDipOnly(
 		final List<CorrectableReportableSellerType> correctableReportableSellerTypes,
 		final CorrectablePlatformOperatorType correctablePlatformOperatorType)
-		throws HttpStatusCodeNotExceptedException
 	{
-		try(final WebClient client = new WebClient(this.configuration))
-		{
-			return this.sendDipOnlyInternal(correctableReportableSellerTypes, correctablePlatformOperatorType, client);
-		}
+		return this.sendDipOnlyInternal(correctableReportableSellerTypes, correctablePlatformOperatorType);
 	}
 
 	/**
 	 * Sends the message and queries a result.
 	 * <p>
 	 *     Querying the result might take a few seconds and is configured in
-	 *     {@link BzstDipConfiguration#queryResultConfiguration}.
+	 *     {@link BzstDipConfiguration#getQueryResultConfiguration()}.
 	 * </p>
 	 * <p>
 	 *     In special cases {@link #sendDipOnly(BzstDipMessage)} can be used, if the result is not needed,
@@ -129,7 +142,7 @@ public BzstDipSendingResult sendDipOnly(
 	 * @return the result which contains the dataTransferNumber and all found responses in the API.
 	 */
 	public BzstDipCompleteResult sendDipAndQueryResult(final BzstDipMessage message)
-		throws HttpStatusCodeNotExceptedException, InterruptedException, IOException
+		throws InterruptedException, IOException
 	{
 		return this.sendDipAndQueryResult(message.toXmlType(this.configuration));
 	}
@@ -138,7 +151,7 @@ public BzstDipCompleteResult sendDipAndQueryResult(final BzstDipMessage message)
 	 * Sends the message and queries a result.
 	 * <p>
 	 *     Querying the result might take a few seconds and is configured in
-	 *     {@link BzstDipConfiguration#queryResultConfiguration}.
+	 *     {@link BzstDipConfiguration#getQueryResultConfiguration()}.
 	 * </p>
 	 * <p>
 	 *     In special cases {@link #sendDipOnly(String)} can be used, if the result is not needed,
@@ -148,7 +161,7 @@ public BzstDipCompleteResult sendDipAndQueryResult(final BzstDipMessage message)
 	 * @return the result which contains the dataTransferNumber and all found responses in the API.
 	 */
 	public BzstDipCompleteResult sendDipAndQueryResult(final String csvData)
-		throws HttpStatusCodeNotExceptedException, InterruptedException, IOException
+		throws InterruptedException, IOException
 	{
 		return this.sendDipAndQueryResult(ReportableSellerCsvFileParser.parseCsvData(csvData, this.configuration));
 	}
@@ -157,7 +170,7 @@ public BzstDipCompleteResult sendDipAndQueryResult(final String csvData)
 	 * Sends the message and queries a result.
 	 * <p>
 	 *     Querying the result might take a few seconds and is configured in
-	 *     {@link BzstDipConfiguration#queryResultConfiguration}.
+	 *     {@link BzstDipConfiguration#getQueryResultConfiguration()}.
 	 * </p>
 	 * <p>
 	 *     In special cases {@link #sendDipOnly(List)} can be used, if the result is not needed,
@@ -169,7 +182,7 @@ public BzstDipCompleteResult sendDipAndQueryResult(final String csvData)
 	public BzstDipCompleteResult sendDipAndQueryResult(
 		final List<CorrectableReportableSellerType> correctableReportableSellerTypes
 	)
-		throws HttpStatusCodeNotExceptedException, InterruptedException, IOException
+		throws InterruptedException, IOException
 	{
 		return this.sendDipAndQueryResult(
 			correctableReportableSellerTypes,
@@ -181,7 +194,7 @@ public BzstDipCompleteResult sendDipAndQueryResult(
 	 * Sends the message and queries a result.
 	 * <p>
 	 *     Querying the result might take a few seconds and is configured in
-	 *     {@link BzstDipConfiguration#queryResultConfiguration}.
+	 *     {@link BzstDipConfiguration#getQueryResultConfiguration()}.
 	 * </p>
 	 * <p>
 	 *     In special cases {@link #sendDipOnly(List, CorrectablePlatformOperatorType)} can be used, if the result is
@@ -196,19 +209,16 @@ public BzstDipCompleteResult sendDipAndQueryResult(
 		final List<CorrectableReportableSellerType> correctableReportableSellerTypes,
 		final CorrectablePlatformOperatorType correctablePlatformOperatorType
 	)
-		throws HttpStatusCodeNotExceptedException, InterruptedException, IOException
+		throws InterruptedException, IOException
 	{
-		try(final WebClient client = new WebClient(this.configuration))
-		{
 			final BzstDipSendingResult sendingResult =
-				this.sendDipOnlyInternal(correctableReportableSellerTypes, correctablePlatformOperatorType, client);
+				this.sendDipOnlyInternal(correctableReportableSellerTypes, correctablePlatformOperatorType);
 
 			Thread.sleep(this.configuration.getQueryResultConfiguration().delayBeforeCheckingResults().toMillis());
-			
-			final BzstDipRequestStatusResult requestStatusResult = this.queryDipResultWithRetry(client, sendingResult);
+		
+		final BzstDipRequestStatusResult requestStatusResult = this.queryDipResultWithRetry(sendingResult);
 
 			return BzstDipCompleteResult.fromResult(sendingResult, requestStatusResult);
-		}
 	}
 
 	/**
@@ -217,19 +227,15 @@ public BzstDipCompleteResult sendDipAndQueryResult(
 	 * suggest only using this method, if specifically needed.
 	 * @return all found {@link BzstDipSingleTransferResult}s
 	 */
-	public BzstDipRequestStatusResult queryDipResult() throws HttpStatusCodeNotExceptedException, IOException
+	public BzstDipRequestStatusResult queryDipResult() throws IOException
 	{
-		try(final WebClient client = new WebClient(this.configuration))
-		{
-			return client.readAndConfirmDataTransferNumbers();
-		}
+		return this.webClient.readAndConfirmDataTransferNumbers();
 	}
 
 	private BzstDipSendingResult sendDipOnlyInternal(
 		final List<CorrectableReportableSellerType> correctableReportableSellerTypes,
-		final CorrectablePlatformOperatorType correctablePlatformOperatorType,
-		final WebClient client
-	) throws HttpStatusCodeNotExceptedException
+		final CorrectablePlatformOperatorType correctablePlatformOperatorType
+	)
 	{
 		final XMLDocumentCreator xmlDocumentCreator = new XMLDocumentCreator(this.configuration);
 		final String signedXML =
@@ -242,20 +248,19 @@ private BzstDipSendingResult sendDipOnlyInternal(
 		LOGGER.debug("Created following XML-Document:\n{}", signedXML);
 
 		LOGGER.debug("XML data will now be uploaded...");
-		final String dataTransferNumber = client.getDataTransferNumber();
+		final String dataTransferNumber = this.webClient.getDataTransferNumber();
 		LOGGER.debug("Data transfer number: {}", dataTransferNumber);
 
-		client.uploadMassData(dataTransferNumber, signedXML);
+		this.webClient.uploadMassData(dataTransferNumber, signedXML);
 
-		client.closeSubmission(dataTransferNumber);
+		this.webClient.closeSubmission(dataTransferNumber);
 
 		return new BzstDipSendingResult(dataTransferNumber);
 	}
 
 	private BzstDipRequestStatusResult queryDipResultWithRetry(
-		final WebClient webClient,
 		final BzstDipSendingResult sendingResult)
-		throws HttpStatusCodeNotExceptedException, InterruptedException, IOException
+		throws InterruptedException, IOException
 	{
 		BzstDipRequestStatusResult requestStatusResult;
 		int retryCounter = 0;
@@ -265,7 +270,7 @@ private BzstDipRequestStatusResult queryDipResultWithRetry(
 			{
 				Thread.sleep(this.configuration.getQueryResultConfiguration().delayInBetweenResultChecks().toMillis());
 			}
-			requestStatusResult = webClient.readAndConfirmDataTransferNumbers();
+			requestStatusResult = this.webClient.readAndConfirmDataTransferNumbers();
 			retryCounter++;
 		}
 		while(

bzst-dip-java-client/src/main/java/software/xdev/bzst/dip/client/exception/HttpStatusCodeNotExceptedException.java

@@ -16,15 +16,9 @@
 package software.xdev.bzst.dip.client.util;
 
 import java.io.IOException;
-import java.io.InputStream;
 import java.io.StringReader;
-import java.security.KeyStore;
-import java.security.PrivateKey;
-import java.time.Duration;
 import java.util.ArrayList;
-import java.util.Date;
 import java.util.List;
-import java.util.UUID;
 
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
@@ -39,10 +33,7 @@
 import org.xml.sax.InputSource;
 import org.xml.sax.SAXException;
 
-import io.jsonwebtoken.Jwts;
-import software.xdev.bzst.dip.client.exception.EncryptionException;
 import software.xdev.bzst.dip.client.factory.DocumentBuilderFactoryNoExternalEntities;
-import software.xdev.bzst.dip.client.model.configuration.BzstDipConfiguration;
 
 
 /**
@@ -51,46 +42,12 @@
 public final class WebClientUtil
 {
 	private static final Logger LOGGER = LoggerFactory.getLogger(WebClientUtil.class);
-	public static final String MDS_POSTFIX = "/auth/realms/mds";
 	public static final String TAG_NAME_DATENTRANSFERNUMMER = "Datentransfernummer";
 
 	private WebClientUtil()
 	{
 	}
 
-	public static String createRequestToken(final BzstDipConfiguration configuration)
-	{
-		LOGGER.debug("Creating jwt token...");
-		try(final InputStream keystoreInputStream = configuration.getCertificateKeystoreInputStream().get())
-		{
-			final KeyStore.PrivateKeyEntry privateKeyEntry = SigningUtil.getPrivateKeyEntry(
-				keystoreInputStream,
-				configuration.getCertificateKeystorePassword(),
-				SigningUtil.KEYSTORE_TYPE
-			);
-			
-			final PrivateKey privateKey = privateKeyEntry.getPrivateKey();
-			final String clientId = configuration.getClientId();
-			LOGGER.debug("Using client id: {}", clientId);
-			
-			return Jwts.builder()
-				.issuer(clientId)
-				.subject(clientId)
-				.audience().add(
-					configuration.getRealmEnvironmentBaseUrl() + MDS_POSTFIX)
-				.and()
-				.issuedAt(new Date())
-				.expiration(new Date(System.currentTimeMillis() + Duration.ofMinutes(5).toMillis()))
-				.id(UUID.randomUUID().toString())
-				.notBefore(new Date(System.currentTimeMillis() - Duration.ofMinutes(1).toMillis()))
-				.signWith(privateKey, Jwts.SIG.RS256)
-				.compact();
-		}
-		catch(final IOException ioException)
-		{
-			throw new EncryptionException("An error occurred while creating the request token.", ioException);
-		}
-	}
 
 	public static List<String> extractTransferNumberFromXml(final String xmlString) throws IOException
 	{