From e2be963a0dbbe21f49c6c1b1c78d647e7bbff774 Mon Sep 17 00:00:00 2001 From: James Agnew Date: Sun, 31 Mar 2019 12:35:48 -0400 Subject: [PATCH 1/2] Add support for websockets --- .../fhir/jpa/starter/FhirServerConfigDstu2.java | 2 +- .../fhir/jpa/starter/FhirServerConfigDstu3.java | 2 +- .../uhn/fhir/jpa/starter/FhirServerConfigR4.java | 2 +- .../ca/uhn/fhir/jpa/starter/HapiProperties.java | 10 ---------- src/main/resources/hapi.properties | 11 ++++++----- .../fhir/jpa/starter/ExampleServerDstu2IT.java | 16 +++++----------- .../fhir/jpa/starter/ExampleServerDstu3IT.java | 13 ++++++------- .../uhn/fhir/jpa/starter/ExampleServerR4IT.java | 15 +++++++-------- 8 files changed, 27 insertions(+), 44 deletions(-) diff --git a/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu2.java b/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu2.java index 2335e53..3255de7 100644 --- a/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu2.java +++ b/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu2.java @@ -35,7 +35,7 @@ public class FhirServerConfigDstu2 extends BaseJavaConfigDstu2 { @Bean() public LocalContainerEntityManagerFactoryBean entityManagerFactory() { LocalContainerEntityManagerFactoryBean retVal = super.entityManagerFactory(); - retVal.setPersistenceUnitName(HapiProperties.getPersistenceUnitName()); + retVal.setPersistenceUnitName("HAPI_PU"); try { retVal.setDataSource(myDataSource); diff --git a/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu3.java b/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu3.java index 3eb1d9e..7cf6996 100644 --- a/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu3.java +++ b/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigDstu3.java @@ -35,7 +35,7 @@ public class FhirServerConfigDstu3 extends BaseJavaConfigDstu3 { @Bean() public LocalContainerEntityManagerFactoryBean entityManagerFactory() { LocalContainerEntityManagerFactoryBean retVal = super.entityManagerFactory(); - retVal.setPersistenceUnitName(HapiProperties.getPersistenceUnitName()); + retVal.setPersistenceUnitName("HAPI_PU"); try { retVal.setDataSource(myDataSource); diff --git a/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigR4.java b/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigR4.java index a9957e9..abf6938 100644 --- a/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigR4.java +++ b/src/main/java/ca/uhn/fhir/jpa/starter/FhirServerConfigR4.java @@ -35,7 +35,7 @@ public class FhirServerConfigR4 extends BaseJavaConfigR4 { @Bean() public LocalContainerEntityManagerFactoryBean entityManagerFactory() { LocalContainerEntityManagerFactoryBean retVal = super.entityManagerFactory(); - retVal.setPersistenceUnitName(HapiProperties.getPersistenceUnitName()); + retVal.setPersistenceUnitName("HAPI_PU"); try { retVal.setDataSource(myDataSource); diff --git a/src/main/java/ca/uhn/fhir/jpa/starter/HapiProperties.java b/src/main/java/ca/uhn/fhir/jpa/starter/HapiProperties.java index ad426e9..d15c840 100644 --- a/src/main/java/ca/uhn/fhir/jpa/starter/HapiProperties.java +++ b/src/main/java/ca/uhn/fhir/jpa/starter/HapiProperties.java @@ -32,9 +32,7 @@ public class HapiProperties { static final String LOGGER_NAME = "logger.name"; static final String MAX_FETCH_SIZE = "max_fetch_size"; static final String MAX_PAGE_SIZE = "max_page_size"; - static final String PERSISTENCE_UNIT_NAME = "persistence_unit_name"; static final String SERVER_ADDRESS = "server_address"; - static final String SERVER_BASE = "server.base"; static final String SERVER_ID = "server.id"; static final String SERVER_NAME = "server.name"; static final String SUBSCRIPTION_EMAIL_ENABLED = "subscription.email.enabled"; @@ -201,10 +199,6 @@ public class HapiProperties { return HapiProperties.getIntegerProperty(MAX_FETCH_SIZE, Integer.MAX_VALUE); } - public static String getPersistenceUnitName() { - return HapiProperties.getProperty(PERSISTENCE_UNIT_NAME, "HAPI_PU"); - } - public static String getLoggerName() { return HapiProperties.getProperty(LOGGER_NAME, "fhirtest.access"); } @@ -269,10 +263,6 @@ public class HapiProperties { return HapiProperties.getProperty(CORS_ALLOWED_ORIGIN, "*"); } - public static String getServerBase() { - return HapiProperties.getProperty(SERVER_BASE, "/fhir"); - } - public static String getServerName() { return HapiProperties.getProperty(SERVER_NAME, "Local Tester"); } diff --git a/src/main/resources/hapi.properties b/src/main/resources/hapi.properties index 5487134..8b661b5 100644 --- a/src/main/resources/hapi.properties +++ b/src/main/resources/hapi.properties @@ -6,11 +6,12 @@ fhir_version=DSTU3 # This is the address that the FHIR server will report as its own address. # If this server will be deployed (for example) to an internet accessible # server, put the DNS name of that server here. -server_address=http://localhost:8080/fhir/ - -# This is the context path for the FHIR endpoint. If this is changed, the -# setting above should also be changed. -server.base=/fhir +# +# Note that this is also the address that the hapi-fhir-testpage-overlay +# (the web UI similar to the one at http://hapi.fhir.org) will use to +# connect internally to the FHIR server, so this also needs to be a name +# accessible from the server itself. +server_address=http://localhost:8080/hapi-fhir-jpaserver/fhir/ default_encoding=JSON etag_support=ENABLED diff --git a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu2IT.java b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu2IT.java index e01fc8b..70b4e5f 100644 --- a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu2IT.java +++ b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu2IT.java @@ -13,8 +13,6 @@ import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; -import java.io.File; -import java.io.IOException; import java.nio.file.Paths; import static org.junit.Assert.assertEquals; @@ -33,14 +31,13 @@ public class ExampleServerDstu2IT { HapiProperties.forceReload(); HapiProperties.setProperty(HapiProperties.FHIR_VERSION, "DSTU2"); HapiProperties.setProperty(HapiProperties.DATASOURCE_URL, "jdbc:derby:memory:dbr2;create=true"); - HapiProperties.setProperty(HapiProperties.TEST_PORT, Integer.toString(PortUtil.findFreePort())); ourCtx = FhirContext.forDstu2(); - ourPort = HapiProperties.getTestPort(); + ourPort = PortUtil.findFreePort(); } @Test - public void testCreateAndRead() throws IOException { - ourLog.info("Base URL is: http://localhost:" + ourPort + HapiProperties.getServerBase()); + public void testCreateAndRead() { + ourLog.info("Base URL is: " + HapiProperties.getServerAddress()); String methodName = "testCreateResourceConditional"; Patient pt = new Patient(); @@ -62,13 +59,10 @@ public class ExampleServerDstu2IT { ourLog.info("Project base path is: {}", path); - if (ourPort == 0) { - ourPort = RandomServerPortProvider.findFreePort(); - } ourServer = new Server(ourPort); WebAppContext webAppContext = new WebAppContext(); - webAppContext.setContextPath("/"); + webAppContext.setContextPath("/hapi-fhir-jpaserver"); webAppContext.setDescriptor(path + "/src/main/webapp/WEB-INF/web.xml"); webAppContext.setResourceBase(path + "/target/hapi-fhir-jpaserver-starter"); webAppContext.setParentLoaderPriority(true); @@ -78,7 +72,7 @@ public class ExampleServerDstu2IT { ourCtx.getRestfulClientFactory().setServerValidationMode(ServerValidationModeEnum.NEVER); ourCtx.getRestfulClientFactory().setSocketTimeout(1200 * 1000); - ourServerBase = "http://localhost:" + ourPort + HapiProperties.getServerBase(); + ourServerBase = "http://localhost:" + ourPort + "/hapi-fhir-jpaserver/fhir/"; ourClient = ourCtx.newRestfulGenericClient(ourServerBase); ourClient.registerInterceptor(new LoggingInterceptor(true)); } diff --git a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu3IT.java b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu3IT.java index c481402..4580f9c 100644 --- a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu3IT.java +++ b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerDstu3IT.java @@ -44,15 +44,14 @@ public class ExampleServerDstu3IT { HapiProperties.forceReload(); HapiProperties.setProperty(HapiProperties.FHIR_VERSION, "DSTU3"); HapiProperties.setProperty(HapiProperties.DATASOURCE_URL, "jdbc:derby:memory:dbr3;create=true"); - HapiProperties.setProperty(HapiProperties.TEST_PORT, Integer.toString(PortUtil.findFreePort())); HapiProperties.setProperty(HapiProperties.SUBSCRIPTION_WEBSOCKET_ENABLED, "true"); ourCtx = FhirContext.forDstu3(); - ourPort = HapiProperties.getTestPort(); + ourPort = PortUtil.findFreePort(); } @Test - public void testCreateAndRead() throws IOException { - ourLog.info("Base URL is: http://localhost:" + ourPort + HapiProperties.getServerBase()); + public void testCreateAndRead() { + ourLog.info("Base URL is: " + HapiProperties.getServerAddress()); String methodName = "testCreateResourceConditional"; Patient pt = new Patient(); @@ -92,7 +91,7 @@ public class ExampleServerDstu3IT { SocketImplementation mySocketImplementation = new SocketImplementation(mySubscriptionId.getIdPart(), EncodingEnum.JSON); myWebSocketClient.start(); - URI echoUri = new URI("ws://localhost:" + ourPort + "/websocket"); + URI echoUri = new URI("ws://localhost:" + ourPort + "/hapi-fhir-jpaserver/websocket"); ClientUpgradeRequest request = new ClientUpgradeRequest(); ourLog.info("Connecting to : {}", echoUri); Future connection = myWebSocketClient.connect(mySocketImplementation, echoUri, request); @@ -138,7 +137,7 @@ public class ExampleServerDstu3IT { ourServer = new Server(ourPort); WebAppContext webAppContext = new WebAppContext(); - webAppContext.setContextPath("/"); + webAppContext.setContextPath("/hapi-fhir-jpaserver"); webAppContext.setDescriptor(path + "/src/main/webapp/WEB-INF/web.xml"); webAppContext.setResourceBase(path + "/target/hapi-fhir-jpaserver-starter"); webAppContext.setParentLoaderPriority(true); @@ -148,7 +147,7 @@ public class ExampleServerDstu3IT { ourCtx.getRestfulClientFactory().setServerValidationMode(ServerValidationModeEnum.NEVER); ourCtx.getRestfulClientFactory().setSocketTimeout(1200 * 1000); - ourServerBase = "http://localhost:" + ourPort + HapiProperties.getServerBase(); + ourServerBase = "http://localhost:" + ourPort + "/hapi-fhir-jpaserver/fhir/"; ourClient = ourCtx.newRestfulGenericClient(ourServerBase); ourClient.registerInterceptor(new LoggingInterceptor(true)); } diff --git a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java index ce77acd..3d87090 100644 --- a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java +++ b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java @@ -45,15 +45,14 @@ public class ExampleServerR4IT { HapiProperties.forceReload(); HapiProperties.setProperty(HapiProperties.DATASOURCE_URL, "jdbc:derby:memory:dbr4;create=true"); HapiProperties.setProperty(HapiProperties.FHIR_VERSION, "R4"); - HapiProperties.setProperty(HapiProperties.TEST_PORT, Integer.toString(PortUtil.findFreePort())); HapiProperties.setProperty(HapiProperties.SUBSCRIPTION_WEBSOCKET_ENABLED, "true"); ourCtx = FhirContext.forR4(); - ourPort = HapiProperties.getTestPort(); + ourPort = PortUtil.findFreePort(); } @Test - public void testCreateAndRead() throws IOException { - ourLog.info("Base URL is: http://localhost:" + ourPort + HapiProperties.getServerBase()); + public void testCreateAndRead() { + ourLog.info("Base URL is: " + HapiProperties.getServerAddress()); String methodName = "testCreateResourceConditional"; Patient pt = new Patient(); @@ -93,7 +92,7 @@ public class ExampleServerR4IT { SocketImplementation mySocketImplementation = new SocketImplementation(mySubscriptionId.getIdPart(), EncodingEnum.JSON); myWebSocketClient.start(); - URI echoUri = new URI("ws://localhost:" + ourPort + "/websocket"); + URI echoUri = new URI("ws://localhost:" + ourPort + "/hapi-fhir-jpaserver/websocket"); ClientUpgradeRequest request = new ClientUpgradeRequest(); ourLog.info("Connecting to : {}", echoUri); Future connection = myWebSocketClient.connect(mySocketImplementation, echoUri, request); @@ -139,7 +138,7 @@ public class ExampleServerR4IT { ourServer = new Server(ourPort); WebAppContext webAppContext = new WebAppContext(); - webAppContext.setContextPath("/"); + webAppContext.setContextPath("/hapi-fhir-jpaserver"); webAppContext.setDisplayName("HAPI FHIR"); webAppContext.setDescriptor(path + "/src/main/webapp/WEB-INF/web.xml"); webAppContext.setResourceBase(path + "/target/hapi-fhir-jpaserver-starter"); @@ -150,8 +149,8 @@ public class ExampleServerR4IT { ourCtx.getRestfulClientFactory().setServerValidationMode(ServerValidationModeEnum.NEVER); ourCtx.getRestfulClientFactory().setSocketTimeout(1200 * 1000); - ourServerBase = "http://localhost:" + ourPort + HapiProperties.getServerBase(); - ourClient = ourCtx.newRestfulGenericClient(ourServerBase); + ourServerBase = HapiProperties.getServerAddress(); + ourServerBase = "http://localhost:" + ourPort + "/hapi-fhir-jpaserver/fhir/"; ourClient.registerInterceptor(new LoggingInterceptor(true)); } From 632d4ee97b486ff0c11f863cf0acde779ae4b478 Mon Sep 17 00:00:00 2001 From: James Agnew Date: Sun, 31 Mar 2019 13:11:04 -0400 Subject: [PATCH 2/2] Fix build issues --- README.md | 13 ++++++++++++- pom.xml | 12 ++---------- src/main/resources/hapi.properties | 3 ++- .../ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java | 3 ++- 4 files changed, 18 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 7def907..840f40d 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ mvn jetty:run Then, browse to the following link to use the server: -[http://localhost:8080/](http://localhost:8080/) +[http://localhost:8080/hapi-fhir-jpaserver/](http://localhost:8080/hapi-fhir-jpaserver/) # Deploying to a Container @@ -74,3 +74,14 @@ FLUSH PRIVILEGES; * hibernate.dialect=org.hibernate.dialect.MySQL5Dialect It is important to use MySQL5Dialect when using MySQL version 5+. + +# Enabling Subscriptions + +The server may be configured with subscription support by enabling properties in the [hapi.properties](https://github.com/hapifhir/hapi-fhir-jpaserver-starter/blob/master/src/main/resources/hapi.properties) file: + +* `subscription.resthook.enabled` - Enables REST Hook subscriptions, where the server will make an outgoing connection to a remote REST server + +* `subscription.email.enabled` - Enables email subscriptions. Note that you must also provide the connection details for a usable SMTP server. + +* `subscription.websocket.enabled` - Enables websocket subscriptions. With this enabled, your server will accept incoming websocket connections on the following URL (this example uses the default context path and port, you may need to tweak depending on your deployment environment): [ws://localhost:8080/hapi-fhir-jpaserver/websocket](ws://localhost:8080/hapi-fhir-jpaserver/websocket) + diff --git a/pom.xml b/pom.xml index ca54c6b..736b08b 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ ca.uhn.hapi.fhir hapi-fhir - 3.7.0 + 3.8.0-SNAPSHOT ca.uhn.hapi.fhir.demo @@ -129,14 +129,6 @@ org.apache.derby derby - - org.apache.derby - derbynet - - - org.apache.derby - derbyclient - @@ -204,7 +196,7 @@ 9.4.8.v20180619 - / + /hapi-fhir-jpaserver true diff --git a/src/main/resources/hapi.properties b/src/main/resources/hapi.properties index 8b661b5..e128f2c 100644 --- a/src/main/resources/hapi.properties +++ b/src/main/resources/hapi.properties @@ -1,6 +1,7 @@ # Adjust this to set the version of FHIR supported by this server. See -# FhirVersionEnum for a list of available constants. +# FhirVersionEnum for a list of available constants. Example values include +# DSTU2, DSTU3, R4. fhir_version=DSTU3 # This is the address that the FHIR server will report as its own address. diff --git a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java index 3d87090..bff12bb 100644 --- a/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java +++ b/src/test/java/ca/uhn/fhir/jpa/starter/ExampleServerR4IT.java @@ -22,7 +22,6 @@ import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; -import java.io.IOException; import java.net.URI; import java.nio.file.Paths; import java.util.concurrent.Future; @@ -151,6 +150,8 @@ public class ExampleServerR4IT { ourCtx.getRestfulClientFactory().setSocketTimeout(1200 * 1000); ourServerBase = HapiProperties.getServerAddress(); ourServerBase = "http://localhost:" + ourPort + "/hapi-fhir-jpaserver/fhir/"; + + ourClient = ourCtx.newRestfulGenericClient(ourServerBase); ourClient.registerInterceptor(new LoggingInterceptor(true)); }