5845 add new bulk export hook for parameter massaging (#5846)

* added an additional pointcut * spotless * version bump --------- Co-authored-by: leif stawnyczy <[email protected]>
hapifhir · Apr 15, 2024 · 80d382d · 80d382d
1 parent edd0491
commit 80d382d
Show file tree

Hide file tree

Showing 81 changed files with 220 additions and 92 deletions.
diff --git a/hapi-deployable-pom/pom.xml b/hapi-deployable-pom/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-fhir</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-android/pom.xml b/hapi-fhir-android/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-base/pom.xml b/hapi-fhir-base/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-base/src/main/java/ca/uhn/fhir/interceptor/api/Pointcut.java b/hapi-fhir-base/src/main/java/ca/uhn/fhir/interceptor/api/Pointcut.java
@@ -1080,10 +1080,52 @@ public enum Pointcut implements IPointcut {
  SUBSCRIPTION_TOPIC_AFTER_PERSISTED_RESOURCE_CHECKED(
  void.class, "ca.uhn.fhir.jpa.subscription.model.ResourceModifiedMessage"),
 
+ /**
+ * <b>Storage Hook:</b>
+ * Invoked when a Bulk Export job is being kicked off, but before any permission checks
+ * have been done.
+ * This hook can be used to modify or update parameters as need be before
+ * authorization/permission checks are done.
+ * <p>
+ * Hooks may accept the following parameters:
+ * </p>
+ * <ul>
+ * <li>
+ * ca.uhn.fhir.jpa.bulk.export.api.BulkDataExportOptions - The details of the job being kicked off
+ * </li>
+ * <li>
+ * ca.uhn.fhir.rest.api.server.RequestDetails - A bean containing details about the request that is about to be processed, including details such as the
+ * resource type and logical ID (if any) and other FHIR-specific aspects of the request which have been
+ * pulled out of the servlet request. Note that the bean
+ * properties are not all guaranteed to be populated, depending on how early during processing the
+ * exception occurred. <b>Note that this parameter may be null in contexts where the request is not
+ * known, such as while processing searches</b>
+ * </li>
+ * <li>
+ * ca.uhn.fhir.rest.server.servlet.ServletRequestDetails - A bean containing details about the request that is about to be processed, including details such as the
+ * resource type and logical ID (if any) and other FHIR-specific aspects of the request which have been
+ * pulled out of the servlet request. This parameter is identical to the RequestDetails parameter above but will
+ * only be populated when operating in a RestfulServer implementation. It is provided as a convenience.
+ * </li>
+ * </ul>
+ * <p>
+ * Hooks should return <code>void</code>, and can throw exceptions.
+ * </p>
+ */
+ STORAGE_PRE_INITIATE_BULK_EXPORT(
+ void.class,
+ "ca.uhn.fhir.rest.api.server.bulk.BulkExportJobParameters",
+ "ca.uhn.fhir.rest.api.server.RequestDetails",
+ "ca.uhn.fhir.rest.server.servlet.ServletRequestDetails"),
+
  /**
  * <b>Storage Hook:</b>
  * Invoked when a Bulk Export job is being kicked off. Hook methods may modify
  * the request, or raise an exception to prevent it from being initiated.
+ *
+ * This hook is not guaranteed to be called before permission checks, and so
+ * anu implementers should be cautious of changing the options in ways that would
+ * affect permissions.
  * <p>
  * Hooks may accept the following parameters:
  * </p>

diff --git a/hapi-fhir-bom/pom.xml b/hapi-fhir-bom/pom.xml
@@ -4,15 +4,15 @@
  <modelVersion>4.0.0</modelVersion>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-fhir-bom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <packaging>pom</packaging>
  <name>HAPI FHIR BOM</name>
 
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-checkstyle/pom.xml b/hapi-fhir-checkstyle/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-fhir</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-cli/hapi-fhir-cli-api/pom.xml b/hapi-fhir-cli/hapi-fhir-cli-api/pom.xml
@@ -4,7 +4,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-cli/hapi-fhir-cli-app/pom.xml b/hapi-fhir-cli/hapi-fhir-cli-app/pom.xml
@@ -6,7 +6,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-fhir-cli</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-cli/pom.xml b/hapi-fhir-cli/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-fhir</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-client-okhttp/pom.xml b/hapi-fhir-client-okhttp/pom.xml
@@ -4,7 +4,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-client/pom.xml b/hapi-fhir-client/pom.xml
@@ -4,7 +4,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-converter/pom.xml b/hapi-fhir-converter/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-dist/pom.xml b/hapi-fhir-dist/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-fhir</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-docs/pom.xml b/hapi-fhir-docs/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/...esources/ca/uhn/hapi/fhir/changelog/7_2_0/5845-added-additional-bulk-export-pointcut.yaml b/...esources/ca/uhn/hapi/fhir/changelog/7_2_0/5845-added-additional-bulk-export-pointcut.yaml
@@ -0,0 +1,11 @@
+---
+type: add
+issue: 5845
+title: "Added a new pointcut: STORAGE_PRE_INITIATE_BULK_EXPORT.
+ This pointcut is meant to be called explicitly before
+ STORAGE_INITIATE_BULK_EXPORT, so that parameter
+ manipulation that needs to be done before permission
+ checks (currently done using STORAGE_INITIATE_BULK_EXPORT)
+ can safely be done without risk of affecting permission checks/
+ authorization.
+"
diff --git a/hapi-fhir-jacoco/pom.xml b/hapi-fhir-jacoco/pom.xml
@@ -11,7 +11,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jaxrsserver-base/pom.xml b/hapi-fhir-jaxrsserver-base/pom.xml
@@ -4,7 +4,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpa/pom.xml b/hapi-fhir-jpa/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-base/pom.xml b/hapi-fhir-jpaserver-base/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-elastic-test-utilities/pom.xml b/hapi-fhir-jpaserver-elastic-test-utilities/pom.xml
@@ -6,7 +6,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>
 

diff --git a/hapi-fhir-jpaserver-hfql/pom.xml b/hapi-fhir-jpaserver-hfql/pom.xml
@@ -3,7 +3,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>
 

diff --git a/hapi-fhir-jpaserver-ips/pom.xml b/hapi-fhir-jpaserver-ips/pom.xml
@@ -3,7 +3,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-mdm/pom.xml b/hapi-fhir-jpaserver-mdm/pom.xml
@@ -6,7 +6,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>
 

diff --git a/hapi-fhir-jpaserver-model/pom.xml b/hapi-fhir-jpaserver-model/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-searchparam/pom.xml b/hapi-fhir-jpaserver-searchparam/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-subscription/pom.xml b/hapi-fhir-jpaserver-subscription/pom.xml
@@ -5,7 +5,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>
 

diff --git a/hapi-fhir-jpaserver-test-dstu2/pom.xml b/hapi-fhir-jpaserver-test-dstu2/pom.xml
@@ -6,7 +6,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-test-dstu3/pom.xml b/hapi-fhir-jpaserver-test-dstu3/pom.xml
@@ -6,7 +6,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>

diff --git a/hapi-fhir-jpaserver-test-r4/pom.xml b/hapi-fhir-jpaserver-test-r4/pom.xml
@@ -6,7 +6,7 @@
  <parent>
  <groupId>ca.uhn.hapi.fhir</groupId>
  <artifactId>hapi-deployable-pom</artifactId>
- <version>7.1.8-SNAPSHOT</version>
+ <version>7.1.9-SNAPSHOT</version>
 
  <relativePath>../hapi-deployable-pom/pom.xml</relativePath>
  </parent>