100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Set IdentityService to start before PersistenceService (#1306)
Rich Turnerc103164896ea
diff --git a/container/src/main/java/org/openremote/container/security/IdentityService.java b/container/src/main/java/org/openremote/container/security/IdentityService.javaindex 2c2b57c54..1cd1090b5 100644--- a/container/src/main/java/org/openremote/container/security/IdentityService.java+++ b/container/src/main/java/org/openremote/container/security/IdentityService.java@@ -34,11 +34,6 @@ import java.util.logging.Logger;import static org.openremote.container.util.MapAccess.*;-/**- * Needs to run before persistence service because if BASIC identity provider is configured then flyway must be- * configured to manage PUBLIC schema for user data; that configuration is done by the- * {@link org.openremote.container.security.basic.BasicIdentityProvider} and must happen before flyway initialisation.- */public abstract class IdentityService implements ContainerService {public static final int PRIORITY = PersistenceService.PRIORITY + 10;@@ -58,8 +53,7 @@ public abstract class IdentityService implements ContainerService {@Overridepublic void init(Container container) throws Exception {devMode = container.isDevMode();- String identityProviderType = getString(container.getConfig(), OR_IDENTITY_PROVIDER, OR_IDENTITY_PROVIDER_DEFAULT);- identityProvider = createIdentityProvider(container, identityProviderType);+ identityProvider = createIdentityProvider(container);identityProvider.init(container);}@@ -115,5 +109,5 @@ public abstract class IdentityService implements ContainerService {/*** To configure the {@link IdentityProvider}, subclasses should override {@link #init(Container)}.*/- abstract public IdentityProvider createIdentityProvider(Container container, String type);+ abstract public IdentityProvider createIdentityProvider(Container container);}diff --git a/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.java b/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.javaindex 3c7bb2333..a1ebe95da 100644--- a/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.java+++ b/container/src/main/java/org/openremote/container/security/keycloak/KeycloakIdentityProvider.java@@ -177,7 +177,6 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {keycloakServiceUri.path(keycloakPath);}-LOG.info("Keycloak service URL: " + keycloakServiceUri.build());ResteasyClientBuilderImpl clientBuilder = new ResteasyClientBuilderImpl()@@ -219,10 +218,6 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {.setReuseXForwarded(true).build();}-- // TODO Not a great way to block startup while we wait for other services (Hystrix?)- waitForKeycloak();- LOG.info("Keycloak identity provider available: " + keycloakServiceUri.build());}@Override@@ -305,45 +300,6 @@ public abstract class KeycloakIdentityProvider implements IdentityProvider {}}- protected void waitForKeycloak() {- boolean keycloakAvailable = false;- WebTargetBuilder targetBuilder = new WebTargetBuilder(httpClient, keycloakServiceUri.build());- ResteasyWebTarget target = targetBuilder.build();- KeycloakResource keycloakResource = target.proxy(KeycloakResource.class);-- while (!keycloakAvailable) {- LOG.info("Connecting to Keycloak server: " + keycloakServiceUri.build());- try {- pingKeycloak(keycloakResource);- keycloakAvailable = true;- } catch (Exception ex) {- LOG.info("Keycloak server not available, waiting...");- try {- Thread.sleep(3000);- } catch (InterruptedException e) {- throw new RuntimeException(e);- }- }- }- }-- protected void pingKeycloak(KeycloakResource resource) throws Exception {- Response response = null;-- try {- response = resource.getWelcomePage();- if (response != null &&- (response.getStatusInfo().getFamily() == SUCCESSFUL- || response.getStatusInfo().getFamily() == REDIRECTION)) {- return;- }- throw new Exception();- } finally {- if (response != null)- response.close();- }- }-public synchronized KeycloakDeployment getKeycloakDeployment(String realm, String clientId) {if (realm == null || clientId == null) {return null;diff --git a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityService.java b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityService.javaindex cfcd4e8ba..9ea6d9d7f 100644--- a/manager/src/main/java/org/openremote/manager/security/ManagerIdentityService.java+++ b/manager/src/main/java/org/openremote/manager/security/ManagerIdentityService.java@@ -19,7 +19,6 @@*/package org.openremote.manager.security;-import org.openremote.container.persistence.PersistenceService;import org.openremote.container.security.IdentityService;import org.openremote.container.timer.TimerService;import org.openremote.manager.mqtt.MQTTBrokerService;@@ -29,17 +28,17 @@ import org.openremote.model.Container;import java.util.Locale;import java.util.logging.Logger;+import static org.openremote.container.util.MapAccess.getString;+public class ManagerIdentityService extends IdentityService {private static final Logger LOG = Logger.getLogger(ManagerIdentityService.class.getName());protected ManagerIdentityProvider identityProvider;- protected PersistenceService persistenceService;@Overridepublic void init(Container container) throws Exception {super.init(container);- persistenceService = container.getService(PersistenceService.class);MQTTBrokerService mqttBrokerService = container.getService(MQTTBrokerService.class);ManagerWebService managerWebService = container.getService(ManagerWebService.class);@@ -56,18 +55,20 @@ public class ManagerIdentityService extends IdentityService {}@Override- public ManagerIdentityProvider createIdentityProvider(Container container, String identityProviderType) {+ public ManagerIdentityProvider createIdentityProvider(Container container) {if (identityProvider == null) {+ String identityProviderType = getString(container.getConfig(), OR_IDENTITY_PROVIDER, OR_IDENTITY_PROVIDER_DEFAULT);+switch (identityProviderType.toLowerCase(Locale.ROOT)) {- case "keycloak":+ case "keycloak" -> {LOG.info("Enabling Keycloak identity provider");this.identityProvider = new ManagerKeycloakIdentityProvider();- break;- case "basic":+ }+ case "basic" -> {LOG.info("Enabling basic identity provider");this.identityProvider = new ManagerBasicIdentityProvider();- break;- default:+ }+ default ->throw new UnsupportedOperationException("Unknown identity provider: " + identityProviderType);}}diff --git a/manager/src/main/java/org/openremote/manager/setup/KeycloakInitService.java b/manager/src/main/java/org/openremote/manager/setup/KeycloakInitService.javanew file mode 100644index 000000000..84d637ca1--- /dev/null+++ b/manager/src/main/java/org/openremote/manager/setup/KeycloakInitService.java@@ -0,0 +1,145 @@+/*+ * Copyright 2024, OpenRemote Inc.+ *+ * See the CONTRIBUTORS.txt file in the distribution for a+ * full listing of individual contributors.+ *+ * This program is free software: you can redistribute it and/or modify+ * it under the terms of the GNU Affero General Public License as+ * published by the Free Software Foundation, either version 3 of the+ * License, or (at your option) any later version.+ *+ * This program is distributed in the hope that it will be useful,+ * but WITHOUT ANY WARRANTY; without even the implied warranty of+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+ * GNU Affero General Public License for more details.+ *+ * You should have received a copy of the GNU Affero General Public License+ * along with this program. If not, see <http://www.gnu.org/licenses/>.+ */++package org.openremote.manager.setup;++import jakarta.ws.rs.core.Response;+import jakarta.ws.rs.core.UriBuilder;+import org.jboss.resteasy.client.jaxrs.ResteasyClient;+import org.jboss.resteasy.client.jaxrs.ResteasyWebTarget;+import org.jboss.resteasy.client.jaxrs.internal.ResteasyClientBuilderImpl;+import org.openremote.container.security.keycloak.KeycloakResource;+import org.openremote.container.web.WebClient;+import org.openremote.container.web.WebTargetBuilder;+import org.openremote.model.Container;+import org.openremote.model.ContainerService;+import org.openremote.model.util.TextUtil;++import java.util.concurrent.TimeUnit;+import java.util.logging.Logger;++import static jakarta.ws.rs.core.Response.Status.Family.REDIRECTION;+import static jakarta.ws.rs.core.Response.Status.Family.SUCCESSFUL;+import static org.openremote.container.security.IdentityService.OR_IDENTITY_PROVIDER;+import static org.openremote.container.security.IdentityService.OR_IDENTITY_PROVIDER_DEFAULT;+import static org.openremote.container.security.keycloak.KeycloakIdentityProvider.*;+import static org.openremote.container.util.MapAccess.getInteger;+import static org.openremote.container.util.MapAccess.getString;++/**+ * Service just to wait for keycloak availability+ *+ */+// TODO Not a great way to block startup while we wait for other services (Hystrix?)+public class KeycloakInitService implements ContainerService {++ private static final Logger LOG = Logger.getLogger(KeycloakInitService.class.getName());++ @Override+ public void init(Container container) throws Exception {+ String identityProviderType = getString(container.getConfig(), OR_IDENTITY_PROVIDER, OR_IDENTITY_PROVIDER_DEFAULT);++ if (!identityProviderType.equalsIgnoreCase("keycloak")) {+ return;+ }++ waitForKeycloak(container);+ }++ @Override+ public void start(Container container) throws Exception {++ }++ @Override+ public void stop(Container container) throws Exception {++ }++ @Override+ public int getPriority() {+ return HIGH_PRIORITY - 100;+ }++ public static void waitForKeycloak(Container container) {+ UriBuilder keycloakServiceUri =+ UriBuilder.fromPath("/")+ .scheme("http")+ .host(getString(container.getConfig(), OR_KEYCLOAK_HOST, OR_KEYCLOAK_HOST_DEFAULT))+ .port(getInteger(container.getConfig(), OR_KEYCLOAK_PORT, OR_KEYCLOAK_PORT_DEFAULT));++ String keycloakPath = getString(container.getConfig(), OR_KEYCLOAK_PATH, OR_KEYCLOAK_PATH_DEFAULT);++ if (!TextUtil.isNullOrEmpty(keycloakPath)) {+ keycloakServiceUri.path(keycloakPath);+ }++ ResteasyClientBuilderImpl clientBuilder = new ResteasyClientBuilderImpl()+ .connectTimeout(+ getInteger(container.getConfig(), KEYCLOAK_CONNECT_TIMEOUT, KEYCLOAK_CONNECT_TIMEOUT_DEFAULT),+ TimeUnit.MILLISECONDS+ )+ .readTimeout(+ getInteger(container.getConfig(), KEYCLOAK_REQUEST_TIMEOUT, KEYCLOAK_REQUEST_TIMEOUT_DEFAULT),+ TimeUnit.MILLISECONDS+ )+ .connectionPoolSize(+ getInteger(container.getConfig(), KEYCLOAK_CLIENT_POOL_SIZE, KEYCLOAK_CLIENT_POOL_SIZE_DEFAULT)+ );+ ResteasyClient httpClient = WebClient.registerDefaults(clientBuilder).build();++ boolean keycloakAvailable = false;+ WebTargetBuilder targetBuilder = new WebTargetBuilder(httpClient, keycloakServiceUri.build());+ ResteasyWebTarget target = targetBuilder.build();+ KeycloakResource keycloakResource = target.proxy(KeycloakResource.class);++ while (!keycloakAvailable) {+ LOG.info("Connecting to Keycloak server: " + keycloakServiceUri.build());+ try {+ pingKeycloak(keycloakResource);+ keycloakAvailable = true;+ } catch (Exception ex) {+ LOG.info("Keycloak server not available, waiting...");+ try {+ Thread.sleep(3000);+ } catch (InterruptedException e) {+ throw new RuntimeException(e);+ }+ }+ }+ }++ protected static void pingKeycloak(KeycloakResource resource) throws Exception {+ Response response = null;++ try {+ response = resource.getWelcomePage();+ if (response != null &&+ (response.getStatusInfo().getFamily() == SUCCESSFUL+ || response.getStatusInfo().getFamily() == REDIRECTION)) {+ return;+ }+ throw new Exception();+ } finally {+ if (response != null)+ response.close();+ }+ }+}diff --git a/manager/src/main/java/org/openremote/manager/setup/SetupService.java b/manager/src/main/java/org/openremote/manager/setup/SetupService.javaindex 2cf2b10db..4288b4ed9 100644--- a/manager/src/main/java/org/openremote/manager/setup/SetupService.java+++ b/manager/src/main/java/org/openremote/manager/setup/SetupService.java@@ -83,7 +83,7 @@ public class SetupService implements ContainerService {}).toList());try {- if (tasks.size() > 0) {+ if (!tasks.isEmpty()) {LOG.info("--- EXECUTING INIT TASKS ---");for (Setup setup : tasks) {LOG.info("Executing setup task '" + setup.getClass().getName() + "'");@@ -100,7 +100,7 @@ public class SetupService implements ContainerService {public void start(Container container) {try {- if (tasks.size() > 0) {+ if (!tasks.isEmpty()) {LOG.info("--- EXECUTING START TASKS ---");for (Setup setup : tasks) {LOG.info("Executing setup task '" + setup.getClass().getName() + "'");diff --git a/manager/src/main/resources/META-INF/services/org.openremote.model.ContainerService b/manager/src/main/resources/META-INF/services/org.openremote.model.ContainerServiceindex 1f063812c..15148ac95 100644--- a/manager/src/main/resources/META-INF/services/org.openremote.model.ContainerService+++ b/manager/src/main/resources/META-INF/services/org.openremote.model.ContainerService@@ -33,3 +33,4 @@ org.openremote.manager.dashboard.DashboardStorageServiceorg.openremote.manager.security.AuthorisationServiceorg.openremote.manager.app.ConfigurationServiceorg.openremote.manager.asset.ForecastService+org.openremote.manager.setup.KeycloakInitService