Added new SMP client exception SMPClientParticipantNotFoundException

phax · Jul 10, 2024 · cf86ba3 · cf86ba3
1 parent f13d11b
commit cf86ba3
Show file tree

Hide file tree

Showing 9 changed files with 142 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -286,6 +286,9 @@ They depend on several other libraries so I suggest you are going for the Maven
 
 # News and noteworthy
 
+* v9.4.1 - work in progress
+    * Added new submodule `dbnalliance-xhe`. See [#53](https://github.com/phax/peppol-commons/pull/53) - thx @robinsongarciax
+    * Added new SMP client exception `SMPClientParticipantNotFoundException` to indicate non-existing Service Groups
 * v9.4.0 - 2024-05-24
     * Renamed `IParticipantIdentifierScheme` to `IPeppolParticipantIdentifierScheme`
     * Tried to make the usage of `IIdentifierFactory` more customizable

diff --git a/peppol-smp-client/src/main/java/com/helger/smpclient/bdxr1/BDXRClient.java b/peppol-smp-client/src/main/java/com/helger/smpclient/bdxr1/BDXRClient.java
@@ -40,6 +40,7 @@
 import com.helger.smpclient.exception.SMPClientBadRequestException;
 import com.helger.smpclient.exception.SMPClientException;
 import com.helger.smpclient.exception.SMPClientNotFoundException;
+import com.helger.smpclient.exception.SMPClientParticipantNotFoundException;
 import com.helger.smpclient.exception.SMPClientUnauthorizedException;
 import com.helger.smpclient.httpclient.SMPHttpResponseHandlerWriteOperations;
 import com.helger.smpclient.url.ISMPURLProvider;
@@ -212,8 +213,10 @@ public ServiceGroupType saveServiceGroup (@Nonnull final IParticipantIdentifier
    *        <code>null</code>.
    * @throws SMPClientException
    *         in case something goes wrong
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
    * @throws SMPClientBadRequestException
@@ -271,9 +274,10 @@ private void _saveServiceInformation (@Nonnull final ParticipantIdentifierType a
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         A HTTP Not Found was received. This can happen if the service was
-   *         not found.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #saveServiceRedirect(ParticipantIdentifierType,
@@ -313,9 +317,10 @@ public void saveServiceInformation (@Nonnull final ServiceInformationType aServi
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         A HTTP Not Found was received. This can happen if the service was
-   *         not found.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #saveServiceInformation(ServiceInformationType,
@@ -353,8 +358,10 @@ public void saveServiceRedirect (@Nonnull final ParticipantIdentifierType aServi
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service meta data object did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    */

diff --git a/peppol-smp-client/src/main/java/com/helger/smpclient/bdxr2/BDXR2Client.java b/peppol-smp-client/src/main/java/com/helger/smpclient/bdxr2/BDXR2Client.java
@@ -41,6 +41,7 @@
 import com.helger.smpclient.exception.SMPClientBadRequestException;
 import com.helger.smpclient.exception.SMPClientException;
 import com.helger.smpclient.exception.SMPClientNotFoundException;
+import com.helger.smpclient.exception.SMPClientParticipantNotFoundException;
 import com.helger.smpclient.exception.SMPClientUnauthorizedException;
 import com.helger.smpclient.httpclient.SMPHttpResponseHandlerWriteOperations;
 import com.helger.smpclient.url.ISMPURLProvider;
@@ -213,8 +214,10 @@ public ServiceGroupType saveServiceGroup (@Nonnull final IParticipantIdentifier
    *        <code>null</code>.
    * @throws SMPClientException
    *         in case something goes wrong
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
    * @throws SMPClientBadRequestException
@@ -275,9 +278,10 @@ private void _saveServiceInformation (@Nonnull final ServiceMetadataType aServic
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         A HTTP Not Found was received. This can happen if the service was
-   *         not found.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #saveServiceRedirect(ParticipantIDType, IDType, RedirectType,
@@ -321,9 +325,10 @@ public void saveServiceEndpoints (@Nonnull final ParticipantIDType aServiceGroup
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         A HTTP Not Found was received. This can happen if the service was
-   *         not found.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #saveServiceEndpoints(ParticipantIDType, IDType, List,
@@ -368,8 +373,10 @@ public void saveServiceRedirect (@Nonnull final ParticipantIDType aServiceGroupI
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service meta data object did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    */

diff --git a/peppol-smp-client/src/main/java/com/helger/smpclient/bdxr2/BDXR2ClientReadOnly.java b/peppol-smp-client/src/main/java/com/helger/smpclient/bdxr2/BDXR2ClientReadOnly.java
@@ -47,6 +47,7 @@
 import com.helger.smpclient.exception.SMPClientBadRequestException;
 import com.helger.smpclient.exception.SMPClientException;
 import com.helger.smpclient.exception.SMPClientNotFoundException;
+import com.helger.smpclient.exception.SMPClientParticipantNotFoundException;
 import com.helger.smpclient.exception.SMPClientUnauthorizedException;
 import com.helger.smpclient.httpclient.AbstractGenericSMPClient;
 import com.helger.smpclient.httpclient.SMPHttpResponseHandlerSigned;
@@ -157,8 +158,10 @@ public BDXR2ClientReadOnly (@Nonnull final URI aSMPHost)
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         A HTTP Forbidden was received, should not happen.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #getServiceGroupOrNull(IParticipantIdentifier)
@@ -191,7 +194,7 @@ public ServiceGroupType getServiceGroupOrNull (@Nonnull final IParticipantIdenti
     {
       return getServiceGroup (aServiceGroupID);
     }
-    catch (final SMPClientNotFoundException ex)
+    catch (final SMPClientNotFoundException | SMPClientParticipantNotFoundException ex)
     {
       if (LOGGER.isDebugEnabled ())
         LOGGER.debug ("Found no ServiceGroup");
@@ -251,8 +254,10 @@ public static ICommonsList <IDocumentTypeIdentifier> getAllDocumentTypes (@Nulla
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         A HTTP Forbidden was received, should not happen.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id or document type did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #getServiceMetadataOrNull(IParticipantIdentifier,
@@ -420,7 +425,7 @@ public ServiceMetadataType getServiceMetadataOrNull (@Nonnull final IParticipant
     {
       return getServiceMetadata (aServiceGroupID, aDocumentTypeID);
     }
-    catch (final SMPClientNotFoundException ex)
+    catch (final SMPClientNotFoundException | SMPClientParticipantNotFoundException ex)
     {
       if (LOGGER.isDebugEnabled ())
         LOGGER.debug ("Found no ServiceMetadata");
@@ -567,8 +572,10 @@ public static X509Certificate getEndpointCertificate (@Nullable final EndpointTy
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         A HTTP Forbidden was received, should not happen.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @throws SMPDNSResolutionException
@@ -600,8 +607,10 @@ public static ServiceGroupType getServiceGroupByDNS (@Nonnull final ISMPURLProvi
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         A HTTP Forbidden was received, should not happen.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id or document type did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @throws SMPDNSResolutionException

diff --git a/...l-smp-client/src/main/java/com/helger/smpclient/exception/SMPClientNotFoundException.java b/...l-smp-client/src/main/java/com/helger/smpclient/exception/SMPClientNotFoundException.java
@@ -23,8 +23,11 @@
 
 import org.apache.hc.client5.http.HttpResponseException;
 
+import com.helger.commons.annotation.DevelopersNote;
+
 /**
- * This exception is thrown, if the HTTP response was 404.
+ * This exception is thrown, if the HTTP response was 404. See also
+ * {@link SMPClientParticipantNotFoundException}.
  *
  * @author Philip Helger
  */
@@ -35,11 +38,15 @@ public SMPClientNotFoundException (@Nonnull final HttpResponseException ex)
     super (ex);
   }
 
+  @Deprecated (forRemoval = true, since = "9.4.1")
+  @DevelopersNote ("Use SMPClientParticipantNotFoundException instead")
   public SMPClientNotFoundException (@Nonnull final UnknownHostException ex)
   {
     super (ex);
   }
 
+  @Deprecated (forRemoval = true, since = "9.4.1")
+  @DevelopersNote ("Use SMPClientParticipantNotFoundException instead")
   public SMPClientNotFoundException (@Nonnull final ConnectException ex)
   {
     super (ex);

diff --git a/...t/src/main/java/com/helger/smpclient/exception/SMPClientParticipantNotFoundException.java b/...t/src/main/java/com/helger/smpclient/exception/SMPClientParticipantNotFoundException.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2015-2024 Philip Helger
+ * philip[at]helger[dot]com
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.helger.smpclient.exception;
+
+import java.net.ConnectException;
+import java.net.UnknownHostException;
+
+import javax.annotation.Nonnull;
+
+/**
+ * This exception is thrown if a participant was not found on the network
+ *
+ * @author Philip Helger
+ * @since 9.4.1
+ */
+public class SMPClientParticipantNotFoundException extends SMPClientException
+{
+  public SMPClientParticipantNotFoundException (@Nonnull final UnknownHostException ex)
+  {
+    super (ex);
+  }
+
+  public SMPClientParticipantNotFoundException (@Nonnull final ConnectException ex)
+  {
+    super (ex);
+  }
+}
diff --git a/...ol-smp-client/src/main/java/com/helger/smpclient/httpclient/AbstractGenericSMPClient.java b/...ol-smp-client/src/main/java/com/helger/smpclient/httpclient/AbstractGenericSMPClient.java
@@ -52,6 +52,7 @@
 import com.helger.smpclient.exception.SMPClientBadRequestException;
 import com.helger.smpclient.exception.SMPClientException;
 import com.helger.smpclient.exception.SMPClientNotFoundException;
+import com.helger.smpclient.exception.SMPClientParticipantNotFoundException;
 import com.helger.smpclient.exception.SMPClientUnauthorizedException;
 import com.helger.xsds.xmldsig.X509DataType;
 
@@ -444,9 +445,9 @@ public static SMPClientException getConvertedException (@Nonnull final Exception
 
     // Special case
     if (ex instanceof UnknownHostException)
-      return new SMPClientNotFoundException ((UnknownHostException) ex);
+      return new SMPClientParticipantNotFoundException ((UnknownHostException) ex);
     if (ex instanceof ConnectException)
-      return new SMPClientNotFoundException ((ConnectException) ex);
+      return new SMPClientParticipantNotFoundException ((ConnectException) ex);
 
     // For new SMPClientBadResponseException
     if (ex instanceof ClientProtocolException && ex.getCause () instanceof SMPClientException)

diff --git a/peppol-smp-client/src/main/java/com/helger/smpclient/peppol/SMPClient.java b/peppol-smp-client/src/main/java/com/helger/smpclient/peppol/SMPClient.java
@@ -39,6 +39,7 @@
 import com.helger.smpclient.exception.SMPClientBadRequestException;
 import com.helger.smpclient.exception.SMPClientException;
 import com.helger.smpclient.exception.SMPClientNotFoundException;
+import com.helger.smpclient.exception.SMPClientParticipantNotFoundException;
 import com.helger.smpclient.exception.SMPClientUnauthorizedException;
 import com.helger.smpclient.httpclient.SMPHttpResponseHandlerWriteOperations;
 import com.helger.smpclient.peppol.marshal.SMPMarshallerServiceGroupType;
@@ -208,8 +209,10 @@ public ServiceGroupType saveServiceGroup (@Nonnull final IParticipantIdentifier
    *        <code>null</code>.
    * @throws SMPClientException
    *         in case something goes wrong
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service group id did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
    * @throws SMPClientBadRequestException
@@ -267,9 +270,10 @@ private void _saveServiceInformation (@Nonnull final IParticipantIdentifier aSer
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         A HTTP Not Found was received. This can happen if the service was
-   *         not found.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #saveServiceRedirect(IParticipantIdentifier, IDocumentTypeIdentifier,
@@ -309,9 +313,10 @@ public void saveServiceInformation (@Nonnull final ServiceInformationType aServi
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         A HTTP Not Found was received. This can happen if the service was
-   *         not found.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    * @see #saveServiceInformation(ServiceInformationType,
@@ -349,8 +354,10 @@ public void saveServiceRedirect (@Nonnull final IParticipantIdentifier aServiceG
    *         in case something goes wrong
    * @throws SMPClientUnauthorizedException
    *         The user name or password was not correct.
+   * @throws SMPClientParticipantNotFoundException
+   *         The service group id does not exist in the network.
    * @throws SMPClientNotFoundException
-   *         The service meta data object did not exist.
+   *         The service group id or document types did not exist.
    * @throws SMPClientBadRequestException
    *         The request was not well formed.
    */