Skip to content

Commit

Permalink
Deprecate fhir-persistence-proxy
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Bastide <pbastide@us.ibm.com>
  • Loading branch information
prb112 committed Apr 8, 2021
1 parent ce08e1a commit 9e9029e
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The IBM FHIR Server is modular and extensible. The following tables provide an o
|fhir-persistence-schema|Classes for deploying and updating the IBM FHIR Server relational database schema|false|
|fhir-persistence-jdbc|A relational FHIRPersistence implementation that uses JDBC to store and query FHIR resources|false|
|fhir-persistence-scout|A scale out persistence layer to store and query FHIR resources *experimental* |false|
|fhir-persistence-proxy|A custom XADataSource implementation for managing distributed transactions across multiple backends|false|
|fhir-persistence-proxy|A custom XADataSource implementation for managing distributed transactions across multiple backends **No longer included in build**|false|
|fhir-provider|JAX-RS Providers for FHIR XML and JSON and related patch formats|false|
|fhir-notification|[Subscription](https://www.hl7.org/fhir/R4/subscription.html) and notification interfaces and helpers|false|
|fhir-notification-websocket|A fhir-notification implementation that uses WebSockets as described at https://www.hl7.org/fhir/R4/subscription.html#2.46.7.2 |false|
Expand Down
2 changes: 1 addition & 1 deletion build/release/bin/20_test/0_check_dependency_security.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
function build_security_check {
mkdir -p build/release/workarea/release_files/
SEC_LOGS="build/release/workarea/release_files/fhir-parent-build_security_check.log"
mvn -T2C com.redhat.victims.maven:security-versions:check -f "fhir-parent" --log-file "${SEC_LOGS}"
mvn com.redhat.victims.maven:security-versions:check -f "fhir-parent" --log-file "${SEC_LOGS}"

echo "[Report]: "
cat "${SEC_LOGS}" | grep 'is vulnerable to'
Expand Down
6 changes: 3 additions & 3 deletions build/release/bin/20_test/1_code_coverage.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ set -eu -o pipefail

# fhir-examples
export BUILD_PROFILES=" $(jq -r '.build[] | select(.type == "fhir-examples").profiles | map(.) | join(",")' build/release/config/release.json)"
mvn -T2C test jacoco:report-aggregate -f fhir-examples
mvn -T2C test org.jacoco:jacoco-maven-plugin:0.8.6:report-aggregate -f fhir-examples

# fhir-tools
export BUILD_PROFILES=" $(jq -r '.build[] | select(.type == "fhir-tools").profiles | map(.) | join(",")' build/release/config/release.json)"
mvn -T2C test jacoco:report-aggregate -f fhir-tools
mvn -T2C test org.jacoco:jacoco-maven-plugin:0.8.6:report-aggregate -f fhir-tools

# fhir-parent
export BUILD_PROFILES=" $(jq -r '.build[] | select(.type == "fhir-parent").profiles | map(.) | join(",")' build/release/config/release.json)"
mvn -T2C test jacoco:report-aggregate -f fhir-parent -P "${BUILD_PROFILES}"
mvn -T2C test org.jacoco:jacoco-maven-plugin:0.8.6:report-aggregate -f fhir-parent -P "${BUILD_PROFILES}"

# EOF
2 changes: 2 additions & 0 deletions build/release/bin/30_release/0_sonatype.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,7 @@ set -eu -o pipefail
###############################################################################

# https://central.sonatype.org/pages/releasing-the-deployment.html
# https://central.sonatype.org/publish/publish-maven/
mvn deploy

# EOF
6 changes: 2 additions & 4 deletions build/release/bin/50_gather/2_codecov.sh
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,9 @@ set -eu -o pipefail
# SPDX-License-Identifier: Apache-2.0
###############################################################################

# gather diagnostics and relevant files
# To include the distribution, include ' -or -iname fhir-server-distribution.zip'
# or '-or -iname surefire-reports -or -iname jacoco.exec'

mkdir -p build/release/workarea/release_files/test_coverage
tar -czf build/release/workarea/release_files/test_coverage/release-test-coverage-and-logs.tgz $(find . -or -iname jacoco-aggregate -or -iname release-commit-details.txt)

# This is a good location to link with the codecov.io

# EOF
9 changes: 3 additions & 6 deletions docs/src/pages/guides/BringYourOwnPersistence.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,9 @@ When the default `com.ibm.fhir.persistence.jdbc.FHIRPersistenceJDBCFactory` is u
Adding a new relational database type is not for the faint of heart, but the IBM FHIR Server team is here to help!
To add support for an alternative relational database, there are multiple projects to consider:

1. `fhir-persistence-proxy`
2. `fhir-database-utils`
3. `fhir-persistence-schema`
4. `fhir-persistence-jdbc`

The `fhir-persistence-proxy` project provides the default DataSource used by the IBM FHIR Server, but its just a wrapper for the XADataSources provided by the packaged JDBC drivers. To extend this class for a new database type, extend the `datasourceTypeMapping` with a mapping from your own type name (used in `fhir-server-config`) to a classname from your driver that implements the `javax.sql.XADataSource` interface). Note that the proxy jar and your driver must be packaged in the `fhirSharedLib` library defined in the server's `server.xml` in order to use liberty-managed transactions (e.g. for performing a transaction that spans multiple datasources).
1. `fhir-database-utils`
2. `fhir-persistence-schema`
3. `fhir-persistence-jdbc`

The `fhir-database-utils` project provides generic utilities for defining a PhysicalDataModel and applying it to a target database via the IDatabaseAdapter and IVersionHistoryService interfaces. Check out the `com.ibm.fhir.database.utils.db2` and `com.ibm.fhir.database.utils.derby` packages to understand how you might extend the framework with support for a new database type.

Expand Down
1 change: 0 additions & 1 deletion fhir-parent/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@
<module>../conformance/fhir-ig-davinci-pdex</module>
<module>../conformance/fhir-ig-davinci-hrex</module>
<module>../fhir-persistence</module>
<module>../fhir-persistence-proxy</module>
<module>../fhir-persistence-schema</module>
<module>../fhir-persistence-jdbc</module>
<module>../fhir-provider</module>
Expand Down
1 change: 1 addition & 0 deletions fhir-persistence-proxy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fhir-persistence-proxy is deprecated and left in place for backwards compatibillity.

0 comments on commit 9e9029e

Please sign in to comment.