deprecations, javadoc issues

oehf · Dec 27, 2024 · 3720af7 · 3720af7
1 parent c95af33
commit 3720af7
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 19 deletions.
diff --git a/...it/src/main/java/org/openehealth/ipf/commons/audit/protocol/AuditTransmissionChannel.java b/...it/src/main/java/org/openehealth/ipf/commons/audit/protocol/AuditTransmissionChannel.java
@@ -37,12 +37,16 @@
 public enum AuditTransmissionChannel {
 
     UDP("UDP", UDPSyslogSenderProvider.class.getName()),
+    @Deprecated(forRemoval = true, since = "5.0.0")
     NIO_UDP("NIO-UDP", UDPSyslogSenderProvider.class.getName()),
+    @Deprecated(forRemoval = true, since = "5.0.0")
     VERTX_UDP("VERTX-UDP", UDPSyslogSenderProvider.class.getName()),
     TLS("TLS", TLSSyslogSenderProvider.class.getName()),
+    @Deprecated(forRemoval = true, since = "5.0.0")
     NIO_TLS("NIO-TLS", NettyTLSSyslogSenderProvider.class.getName()),
     NETTY_TLS("NETTY-TLS", NettyTLSSyslogSenderProvider.class.getName()),
     REACTOR_NETTY_TLS("REACTOR-NETTY-TLS", ReactorNettyTLSSyslogSenderProvider.class.getName()),
+    @Deprecated(forRemoval = true, since = "5.0.0")
     FHIR_REST_TLS("FHIR-REST-TLS", "org.openehealth.ipf.commons.ihe.fhir.audit.protocol.FhirRestTLSAuditRecordApacheSenderProvider"),
     FHIR_REST_APACHE5_TLS("FHIR-REST-APACHE5-TLS", "org.openehealth.ipf.commons.ihe.fhir.audit.protocol.FhirRestTLSAuditRecordApache5SenderProvider"),
     FHIR_REST_METHANOL_TLS("FHIR-REST-METHANOL-TLS", "org.openehealth.ipf.commons.ihe.fhir.audit.protocol.FhirRestTLSAuditRecordMethanolSenderProvider"),

diff --git a/commons/ihe/fhir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/FhirProvider.java b/commons/ihe/fhir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/FhirProvider.java
@@ -107,7 +107,6 @@ protected Map<String, Object> enrichParameters(FhirSearchParameters parameters,
         if (cipherSuite != null) {
             enriched.put(Constants.HTTP_X509_CERTIFICATES, httpServletRequest.getAttribute("javax.security.cert.X509Certificate"));
         }
-
         if (parameters != null) {
             enriched.put(Constants.FHIR_REQUEST_PARAMETERS, parameters);
         }

diff --git a/...ons/ihe/fhir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/RequestConsumer.java b/...ons/ihe/fhir/core/src/main/java/org/openehealth/ipf/commons/ihe/fhir/RequestConsumer.java
@@ -38,7 +38,7 @@
  * on searches.
  * <ul>
  * <li>{@link Constants#FHIR_REQUEST_SIZE_ONLY}: if this entry is present, the requester expects only
- * the result size to be returned in an parameter entry with the same name and calls {@link #handleSizeRequest(Object, Map, Map)}
+ * the result size to be returned in an parameter entry with the same name and calls {@link #handleSizeRequest(Object, Map)}
  * to do so. If possible, implementations should only request the result size from the backend rather than
  * a complete result set.</li>
  * <li>{@link Constants#FHIR_FROM_INDEX} and {@link Constants#FHIR_TO_INDEX}: if these entries are present,
@@ -74,7 +74,7 @@ default boolean test(RequestDetails requestDetails) {
      *
      * @param payload    request payload
      * @param inHeaders  request parameters, e.g. search parameters
-     * @param outHeaders map where Camel response headers will be copied into
+     * @param outHeaders map where response headers will be copied into
      * @return result of the action execution
      */
     MethodOutcome handleAction(Object payload, Map<String, Object> inHeaders, Map<String, Object> outHeaders);
@@ -84,7 +84,7 @@ default boolean test(RequestDetails requestDetails) {
      *
      * @param payload    request payload
      * @param inHeaders  request parameters, e.g. search parameters
-     * @param outHeaders map where Camel response headers will be copied into
+     * @param outHeaders map where response headers will be copied into
      * @param resultType type of the returned resource
      * @param <R>        type of the returned resource
      * @return resource to be returned
@@ -101,7 +101,7 @@ default boolean test(RequestDetails requestDetails) {
      *
      * @param payload    request payload
      * @param inHeaders  request parameters, e.g. search parameters or
-     * @param outHeaders map where Camel response headers will be copied into
+     * @param outHeaders map where response headers will be copied into
      * @param <R>        type of the returned resources contained in the bundle
      * @return list of resources to be returned
      */
@@ -124,7 +124,7 @@ default boolean test(RequestDetails requestDetails) {
      *
      * @param payload    request payload
      * @param inHeaders  request parameters
-     * @param outHeaders map where Camel response headers will be copied into
+     * @param outHeaders map where response headers will be copied into
      * @return transaction response bundle
      */
     <T extends IBaseBundle> T handleTransactionRequest(Object payload, Map<String, Object> inHeaders, Map<String, Object> outHeaders, Class<T> bundleClass);

diff --git a/...g/openehealth/ipf/commons/ihe/fhir/audit/protocol/ApacheFhirRestTLSAuditRecordSender.java b/...g/openehealth/ipf/commons/ihe/fhir/audit/protocol/ApacheFhirRestTLSAuditRecordSender.java
@@ -7,6 +7,10 @@
 import org.openehealth.ipf.commons.ihe.fhir.SslAwareAbstractRestfulClientFactory;
 import org.openehealth.ipf.commons.ihe.fhir.SslAwareApacheRestfulClientFactory;
 
+/**
+ * @deprecated use {@link Apache5FhirRestTLSAuditRecordSender} instead
+ */
+@Deprecated(forRemoval = true, since = "5.0.0")
 public class ApacheFhirRestTLSAuditRecordSender extends AbstractFhirRestTLSAuditRecordSender {
 
     public ApacheFhirRestTLSAuditRecordSender(FhirContext context, String baseUrl) {

diff --git a/.../org/openehealth/ipf/commons/ihe/hl7v2/storage/EhcacheInteractiveContinuationStorage.java b/.../org/openehealth/ipf/commons/ihe/hl7v2/storage/EhcacheInteractiveContinuationStorage.java
@@ -23,7 +23,7 @@
  * @author Dmytro Rud
  * @deprecated
  */
-@Deprecated(forRemoval = true)
+@Deprecated(forRemoval = true, since = "5.0.0")
 public class EhcacheInteractiveContinuationStorage extends JCacheInteractiveContinuationStorage {
 
     public EhcacheInteractiveContinuationStorage(Cache<String, InteractiveContinuationChain> cache) {

diff --git a/...org/openehealth/ipf/commons/ihe/hl7v2/storage/EhcacheUnsolicitedFragmentationStorage.java b/...org/openehealth/ipf/commons/ihe/hl7v2/storage/EhcacheUnsolicitedFragmentationStorage.java
@@ -23,7 +23,7 @@
  * @author Dmytro Rud
  * @deprecated
  */
-@Deprecated(forRemoval = true)
+@Deprecated(forRemoval = true, since = "5.0.0")
 public class EhcacheUnsolicitedFragmentationStorage extends JCacheUnsolicitedFragmentationStorage {
 
     public EhcacheUnsolicitedFragmentationStorage(Cache<String, StringBuilder> cache) {

diff --git a/...n/java/org/openehealth/ipf/commons/ihe/hl7v3/storage/EhcacheHl7v3ContinuationStorage.java b/...n/java/org/openehealth/ipf/commons/ihe/hl7v3/storage/EhcacheHl7v3ContinuationStorage.java
@@ -26,7 +26,7 @@
  * @author Christian Ohr
  * @deprecated
  */
-@Deprecated(forRemoval = true)
+@Deprecated(forRemoval = true, since = "5.0.0")
 public class EhcacheHl7v3ContinuationStorage extends JCacheHl7v3ContinuationStorage {
 
     public EhcacheHl7v3ContinuationStorage(Cache<String, Serializable> cache) {

diff --git a/...ava/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/EhcachePaginationStorage.java b/...ava/org/openehealth/ipf/commons/ihe/hpd/controls/pagination/EhcachePaginationStorage.java
@@ -27,7 +27,7 @@
  * @deprecated
  */
 @Slf4j
-@Deprecated(forRemoval = true)
+@Deprecated(forRemoval = true, since = "5.0.0")
 public class EhcachePaginationStorage extends JCachePaginationStorage {
 
     public EhcachePaginationStorage(Cache<String, Object> cache, boolean needSerialization) {

diff --git a/...main/java/org/openehealth/ipf/commons/ihe/ws/correlation/EhcacheAsynchronyCorrelator.java b/...main/java/org/openehealth/ipf/commons/ihe/ws/correlation/EhcacheAsynchronyCorrelator.java
@@ -25,7 +25,7 @@
  * @author Dmytro Rud
  * @deprecated
  */
-@Deprecated(forRemoval = true)
+@Deprecated(forRemoval = true, since = "5.0.0")
 public class EhcacheAsynchronyCorrelator<AuditDatasetType extends WsAuditDataset> extends JCacheAsynchronyCorrelator<AuditDatasetType> {
 
     public EhcacheAsynchronyCorrelator(Cache<String, Serializable> cache) {

diff --git a/pom.xml b/pom.xml
@@ -44,7 +44,7 @@
         <gmavenplus-plugin-version>4.0.1</gmavenplus-plugin-version>
 
         <jar-plugin-version>3.4.2</jar-plugin-version>
-        <javadoc-plugin-version>3.11.1</javadoc-plugin-version>
+        <javadoc-plugin-version>3.11.2</javadoc-plugin-version>
         <jaxb-plugin-version>3.2.0</jaxb-plugin-version>
         <lombok-plugin-version>1.18.20.0</lombok-plugin-version>
         <nexus-staging-plugin-version>1.6.13</nexus-staging-plugin-version>
@@ -338,19 +338,22 @@
                     <inherited>false</inherited>
                     <configuration>
                         <links>
-                            <link>https://docs.oracle.com/en/java/javase/11/docs/api/</link>
+                            <link>https://docs.oracle.com/en/java/javase/17/docs/api/</link>
                             <link>https://hapifhir.github.io/hapi-hl7v2/base/apidocs/</link>
                             <link>https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-base/</link>
                             <link>https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-server</link>
+                            <link>https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-client</link>
+                            <link>https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-validation</link>
+                            <link>https://hapifhir.io/hapi-fhir/apidocs/hapi-fhir-structures-r4/</link>
                             <link>https://cxf.apache.org/javadoc/latest/</link>
                             <link>https://docs.groovy-lang.org/docs/groovy-${groovy-version}/html/api/</link>
-                            <link>https://www.javadoc.io/doc/org.apache.camel/camel-api/latest/</link>
-                            <link>https://docs.spring.io/spring-framework/docs/6.1.x/javadoc-api/</link>
+                            <link>https://www.javadoc.io/doc/org.apache.camel/camel-api/${camel-version}/</link>
+                            <link>https://docs.spring.io/spring-framework/docs/6.2.x/javadoc-api/</link>
                         </links>
-                        <source>11</source>
+                        <source>17</source>
                         <linksource>false</linksource>
                         <excludePackageNames>*.tutorials,*.test</excludePackageNames>
-                        <additionalJOption>-J-Xmx1024m</additionalJOption>
+                        <additionalJOption>-J-Xmx2048m</additionalJOption>
                         <doclint>none</doclint>
                         <!-- stupid: javadoc:aggregate cannot resolve relative sourcepaths -->
                         <sourcepath>
@@ -361,6 +364,7 @@
                             boot/ipf-hl7v3-spring-boot-starter/generated-stubs:
                             boot/ipf-hpd-spring-boot-starter/generated-stubs:
                             boot/ipf-spring-boot-starter/generated-stubs:
+                            boot/ipf-xacml20-spring-boot-starter/generated-stubs:
                             boot/ipf-xds-spring-boot-starter/generated-stubs:
                             commons/audit/generated-stubs:
                             commons/core/generated-stubs:
@@ -373,12 +377,14 @@
                             commons/ihe/fhir/stu3/qedm/generated-stubs:
                             commons/ihe/fhir/r4/core/generated-stubs:
                             commons/ihe/fhir/r4/audit/generated-stubs:
+                            commons/ihe/fhir/r4/chppqm/generated-stubs:
                             commons/ihe/fhir/r4/mhd/generated-stubs:
                             commons/ihe/fhir/r4/pixpdq/generated-stubs:
                             commons/ihe/fhir/r4/qedm/generated-stubs:
                             commons/ihe/hl7v2/generated-stubs:
                             commons/ihe/hl7v2ws/generated-stubs:
                             commons/ihe/hl7v3/generated-stubs:
+                            commons/ihe/hl7v3model/generated-stubs:
                             commons/ihe/hpd/generated-stubs:
                             commons/ihe/ws/generated-stubs:
                             commons/ihe/xacml20/impl/generated-stubs:
@@ -402,6 +408,7 @@
                             platform-camel/ihe/fhir/stu3/pixpdq/generated-stubs:
                             platform-camel/ihe/fhir/stu3/qedm/generated-stubs:
                             platform-camel/ihe/fhir/r4/audit/generated-stubs:
+                            platform-camel/ihe/fhir/r4/chppqm/generated-stubs:
                             platform-camel/ihe/fhir/r4/mhd/generated-stubs:
                             platform-camel/ihe/fhir/r4/pixpdq/generated-stubs:
                             platform-camel/ihe/fhir/r4/qedm/generated-stubs:
@@ -420,7 +427,7 @@
                         <execution>
                             <id>aggregate</id>
                             <goals>
-                                <goal>aggregate</goal>
+                                <goal>aggregate-no-fork</goal>
                             </goals>
                             <phase>site</phase>
                         </execution>
@@ -446,7 +453,7 @@
                     <version>${maven-dsldoc-plugin-version}</version>
                     <configuration>
                         <links>
-                            <java>http://docs.oracle.com/javase/8/docs/api/</java>
+                            <java>http://docs.oracle.com/javase/17/docs/api/</java>
                             <groovy>http://docs.groovy-lang.org/latest/html/api/</groovy>
                             <org.openehealth.ipf>apidocs/org/openehealth/ipf</org.openehealth.ipf>
                             <org.apache.camel>