From 5c5931953d1e928944a8630da139e86e4b7aa85b Mon Sep 17 00:00:00 2001 From: Ljupcho Palashevski Date: Wed, 26 Jul 2023 19:24:08 +0200 Subject: [PATCH 1/5] Improvements: better availability state handling, runner termination using custom exception, code cleanup. Signed-off-by: Ljupcho Palashevski --- .../server-chassis-spring/build.gradle | 10 +- .../serverchassis/springboot/OMAGServer.java | 194 +++--- .../exception/OMAGServerActivationError.java | 36 ++ .../springboot/exception/package-info.java | 7 + .../src/main/resources/application.properties | 14 +- .../cohort-metadata-access-server.json | 569 ++++++++++++++++++ 6 files changed, 700 insertions(+), 130 deletions(-) create mode 100644 open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/OMAGServerActivationError.java create mode 100644 open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/package-info.java create mode 100644 open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/cohort-metadata-access-server.json diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle b/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle index 7628e5e3a76..ba187bb8c0b 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle @@ -4,8 +4,8 @@ */ plugins { - id 'java' id 'org.springframework.boot' + id "io.freefair.lombok" } @@ -23,10 +23,12 @@ dependencies { implementation 'org.springframework.boot:spring-boot-actuator-autoconfigure' implementation 'org.springframework.boot:spring-boot-actuator' implementation 'org.springframework.boot:spring-boot-starter-tomcat' - implementation 'jakarta.servlet:jakarta.servlet-api' - implementation 'org.slf4j:slf4j-api' implementation 'com.fasterxml.jackson.core:jackson-databind' implementation 'com.fasterxml.jackson.core:jackson-annotations' + implementation 'jakarta.servlet:jakarta.servlet-api' + implementation 'org.slf4j:slf4j-api' + annotationProcessor 'org.projectlombok:lombok' + implementation 'org.projectlombok:lombok' runtimeOnly 'io.micrometer:micrometer-registry-prometheus' runtimeOnly 'ch.qos.logback:logback-classic' @@ -46,11 +48,11 @@ dependencies { runtimeOnly project(':open-metadata-implementation:repository-services:repository-services-spring') runtimeOnly project(':open-metadata-implementation:access-services:asset-manager:asset-manager-spring') runtimeOnly project(':open-metadata-implementation:access-services:asset-catalog:asset-catalog-spring') + runtimeOnly project(':open-metadata-implementation:access-services:data-manager:data-manager-spring') /* Pulling dependencies for some fo the sub-systems enabling 'Integration Daemon' services to test Database Integrator via JDBC integration connector */ // runtimeOnly project(':open-metadata-implementation:integration-services:database-integrator:database-integrator-server') -// runtimeOnly project(':open-metadata-implementation:access-services:data-manager:data-manager-spring') // runtimeOnly 'org.odpi.egeria:egeria-connector-resource-jdbc:1.1' // runtimeOnly 'org.odpi.egeria:egeria-connector-integration-jdbc:1.1' // runtimeOnly 'com.oracle.database.jdbc:ojdbc10:19.19.0.0' diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java index 1d33e6cc4ad..d1dea1bf3d8 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java @@ -6,25 +6,20 @@ import org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig; import org.odpi.openmetadata.platformservices.rest.SuccessMessageResponse; import org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices; +import org.odpi.openmetadata.serverchassis.springboot.exception.OMAGServerActivationError; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; +import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; -import org.springframework.boot.context.event.ApplicationFailedEvent; -import org.springframework.boot.context.event.ApplicationReadyEvent; -import org.springframework.boot.context.event.ApplicationStartedEvent; -import org.springframework.context.ApplicationContextException; -import org.springframework.context.ApplicationEvent; -import org.springframework.context.ApplicationListener; +import org.springframework.context.ConfigurableApplicationContext; import org.springframework.context.event.ContextClosedEvent; import org.springframework.context.event.EventListener; import org.springframework.core.io.Resource; -import org.springframework.stereotype.Component; - import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; @@ -36,173 +31,128 @@ @SpringBootApplication( scanBasePackages = {"org.odpi.openmetadata"} ) -public class OMAGServer { +public class OMAGServer implements ApplicationRunner { private static final Logger LOG = LoggerFactory.getLogger(OMAGServer.class); private final OMAGServerOperationalServices operationalServices; - @Value("${omag.server.user:system}") String omagServerUser; - - @Value("${omag.server.config}") - Resource omagServerConfigLocation; - - @Autowired + @Value("${omag.server.config:#{null}}") + Resource omagServerConfigResource; private ObjectMapper objectMapper; private String serverName = null; private OMAGServerConfig serverConfig = null; + private final ConfigurableApplicationContext context; /** - * Default constructor. - * Creates instance of OMAG operational services. + * Constructor injecting the beans required. + * It also creates instance of OMAGServerOperationalServices. + * @see org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices */ - public OMAGServer() { + @Autowired + public OMAGServer(ObjectMapper objectMapper, ConfigurableApplicationContext ctx) { + this.context = ctx; + this.objectMapper = objectMapper; this.operationalServices = new OMAGServerOperationalServices(); } - public static void main(String[] args) { - new SpringApplicationBuilder() - .listeners(new ApplicationListener() { - @Override - public void onApplicationEvent(ApplicationEvent applicationEvent) { -// LOG.info("[[ OMAGServer ]] >> LISTENER :: {}", applicationEvent.getClass().getCanonicalName()); -// LOG.info("{}listener::{}", OMAG_SERVER, applicationEvent.getClass().getSimpleName()); - } - }) - .sources(OMAGServer.class).run(args); - } - /** - * Handling Spring Boot ApplicationReadyEvent + * Main program, creating spring boot application instance. + * @param args */ - @EventListener(ApplicationReadyEvent.class) - private void onApplicationReadyEvent() { - LOG.info("{} is accepting traffic.", serverName); - } - - /** - * Handling Spring Boot ApplicationStartedEvent - * This handler calls the method for OMAGServerConfig loading. - * - * @link loadServerConfig - */ - @EventListener(ApplicationStartedEvent.class) - private void onApplicationStartedEvent() throws Exception { - LOG.debug("Application started."); - loadServerConfig(); + public static void main(String[] args) { + new SpringApplicationBuilder().sources(OMAGServer.class).run(args); } /** - * Handling Spring Boot ApplicationFailedEvent + * ApplicationRunner implementation. + * The purpose of this class is to provide a standard way to run the OMAG server activation task, separate from the main application thread. + * Executing the server activation in a runner task affects internal availability state by default as the runners are part of the standard application lifecycle. */ - @EventListener(ApplicationFailedEvent.class) - private void onApplicationFailedEvent() { - LOG.debug("Application failed."); + @Override + public void run(ApplicationArguments args) { + LOG.debug("Application runner executing run"); + try { + activateOMAGServerUsingPlatformServices(); + } catch (OMAGServerActivationError e) { + LOG.error("Server activation failed due to internal application error", e); + /** + * Any exception captured at this point means that there was problem activating the OMAG server, thus the application should be shut down. + * Since this is executed as application runner in a separate thread then main propagating the error further does not properly stop the application, instead we are explicitly exiting the application and jvm. + */ + System.exit(SpringApplication.exit(context)); + } } /** * Handling Spring Boot ContextClosedEvent - * This handler provides a way to hook to the standard Spring Boot application shut-down event and call OMAG operational services to deactivate the OMAG server instance. + * This handler provides a way to hook to the standard Spring Boot application shut-down event and call OMAG operational services to deactivate the server instance by name. */ @EventListener(ContextClosedEvent.class) private void onContextClosedEvent() { - LOG.debug("Application stopped."); - if (serverName != null) { - LOG.info("Application stopped, deactivating server {}", serverName); + LOG.info("Application stopped, deactivating server: {}", serverName); operationalServices.deactivateTemporarilyServerList(omagServerUser, List.of(serverName)); } } /** - * This method activates single OMAGServer instance with supplied OMAGServerConfig document. - * Depending on the outcome of activation call, it will change the application availability state. + * This method activates OMAGServer instance using OMAG platform operational services. + * @see org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices + * + * The activation process requires OMAGServerConfig document. + * @see org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig + * + * The OMAGServerConfig document file location is provided as org.springframework.core.io.Resource and configured by application property ${omag.server.config} + * + * @throws OMAGServerActivationError */ - private void activateOMAGServerUsingPlatformServices() { + private void activateOMAGServerUsingPlatformServices() throws OMAGServerActivationError { + + LOG.debug("Activation started"); - LOG.info("Activation started for {}", serverName); + if (omagServerConfigResource == null) { + LOG.info("Configuration loading failed, the cause is that configuration resource provided is null"); + throw new OMAGServerActivationError("Configuration failed, the cause is that configuration resource provided is null"); + } + + try { + LOG.info("Configuration file: {} is being parsed", omagServerConfigResource.getFile()); + LOG.trace("{}", Files.readString(Path.of(omagServerConfigResource.getFile().getPath()))); + serverConfig = objectMapper.reader().readValue(omagServerConfigResource.getFile(), OMAGServerConfig.class); + serverName = serverConfig.getLocalServerName(); + LOG.info("Configuration document for server: {} loaded successfully", serverName); + } catch (IOException e) { + LOG.info("Configuration cannot be loaded from the resource provided"); + throw new OMAGServerActivationError( + String.format("Configuration cannot be loaded from the resource provided"),e); + } if (serverConfig == null) { - LOG.info("Activation failed, the cause is that configuration is null."); - throw new ApplicationContextException("Activation failed the cause is that configuration is null."); + LOG.info("Activation failed, the cause is that configuration is null"); + throw new OMAGServerActivationError("Activation failed the cause is that configuration is null"); - /* TODO: Confirm if this is desired behaviour - This is clearly invalid application state since the OMAG system cannot start - without configuration. Throwing error will close application context and shut the application DOWN.*/ } - LOG.info("Activation started, request sent for server {}", serverName); + LOG.info("Sending activation request for server: {}", serverName); SuccessMessageResponse response = operationalServices .activateWithSuppliedConfig(omagServerUser.trim(), serverConfig.getLocalServerName(), serverConfig); if (response == null) { - LOG.info("Activation has failed. The cause is that response is null."); - throw new ApplicationContextException("Activation has failed. The cause is that response is null."); + LOG.info("Activation has failed. The cause is that response is null"); + throw new OMAGServerActivationError("Activation has failed. The cause is that response is null"); } if (response.getRelatedHTTPCode() != 200) { - LOG.error("Activation failed with response code {}.", response.getRelatedHTTPCode()); - return; - -/* TODO: OMAG system start-up error handling and application readiness probe - In most cases it is state caused by configuration problem and cannot be recovered at runtime - Two options: - 1) Propagate the error further i.e. Runtime/ApplicationContextException which will cause context to be closed and application shut DOWN - throw new ApplicationContextException(response.getExceptionErrorMessage()); - 2) Do not propagate error, log the error message and set application ready state to FALSE - this will keep the application UP and the operator will have to manually change the configuration - and restart the application/container*/ + LOG.info("Activation has failed with response code: {}", response.getRelatedHTTPCode()); + throw new OMAGServerActivationError(String.format("Server activation failed with response code %s", response.getRelatedHTTPCode())); } if (response.getRelatedHTTPCode() == 200) { - LOG.info("Activation succeeded for {} server.", serverConfig.getLocalServerName()); - //TODO: Mark the application state as ready - // i.e. set application ready state to TRUE + LOG.info("Activation succeeded for server: {}", serverConfig.getLocalServerName()); } } - /** - * This method loads the OMAGServerConfig document from location provided by 'omag.server.config' application property defined as spring Resource. - * @see org.springframework.core.io.Resource - */ - private void loadServerConfig() { - - - if (omagServerConfigLocation == null) { - LOG.info("Configuration failed, the cause is that configuration is null."); - //TODO: Confirm if this is desired behaviour (configuration is null) - // This is clearly invalid application state since the OMAG system cannot start without configuration. - // Throwing error will close application context and shut the application DOWN. - throw new ApplicationContextException("Configuration failed, the cause is that configuration is null."); - } - try { - LOG.info("Configuration from file: {} is being parsed.", omagServerConfigLocation.getFile()); - LOG.trace("Configuration from path: {} is being parsed.", Files.readString(Path.of(omagServerConfigLocation.getFile().getPath()))); - serverConfig = objectMapper.reader().readValue(omagServerConfigLocation.getFile(), OMAGServerConfig.class); - serverName = serverConfig.getLocalServerName(); - LOG.info("Configuration loading from document for OMAG server {} succeeded", serverName); - - } catch (IOException e) { - LOG.error("Failed loading OMAG server configuration with exception message : {}", e.getMessage()); - //TODO: Confirm if this is desired behaviour (configuration is null) - // Same as in the case above. - throw new ApplicationContextException( - String.format("Failed loading OMAG server configuration with exception message : {}", e.getMessage())); - } - } - - /** - * Application Runner implementation class. - * The purpose of this class is to provide a standard way to run the OMAG server activation task, separate from the main application tread. - */ - @Component - public class OMAGServerStartup implements ApplicationRunner { - @Override - public void run(ApplicationArguments args) { - LOG.debug("Application running."); - activateOMAGServerUsingPlatformServices(); - } - } } diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/OMAGServerActivationError.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/OMAGServerActivationError.java new file mode 100644 index 00000000000..ee1dde89434 --- /dev/null +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/OMAGServerActivationError.java @@ -0,0 +1,36 @@ +/* SPDX-License-Identifier: Apache-2.0 */ +/* Copyright Contributors to the ODPi Egeria project. */ +package org.odpi.openmetadata.serverchassis.springboot.exception; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.Setter; + +/** + * Custom exception definition used for managing known server start-up error scenarios. + * The application cannot recover from this error. + */ +public class OMAGServerActivationError extends Exception { + + @Getter(AccessLevel.NONE) + @Setter(AccessLevel.NONE) + private static final long serialVersionUID = 1L; + + /** + * Constructs error object by describing the event with message. + * @param errorMessage text message describing the error + */ + public OMAGServerActivationError(String errorMessage) { + super(errorMessage); + } + + /** + * Constructs error object by describing the event with message and providing the original cause of the error. + * @param errorMessage text message describing the error + * @param cause the error cause as instance of java.lang.Throwable + */ + public OMAGServerActivationError(String errorMessage, Throwable cause) { + super(errorMessage, cause); + } + +} diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/package-info.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/package-info.java new file mode 100644 index 00000000000..30b5b2e8b23 --- /dev/null +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/exception/package-info.java @@ -0,0 +1,7 @@ +/* SPDX-License-Identifier: Apache-2.0 */ +/* Copyright Contributors to the ODPi Egeria project. */ + +/** + * This package contains classes used for exception handling. + */ +package org.odpi.openmetadata.serverchassis.springboot.exception; \ No newline at end of file diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties index 439247d633b..35252661a4d 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties @@ -2,12 +2,18 @@ # Copyright Contributors to the ODPi Egeria project. server.port=9443 -omag.server.config=classpath:metadata-access-server.json +omag.server.config=classpath:cohort-metadata-access-server.json scan.packages=com.org.odpi.openmetadata.* +logging.level.org.odpi.openmetadata=error logging.level.org.odpi.openmetadata.frameworks.auditlog=info logging.level.org.odpi.openmetadata.serverchassis.springboot=info -management.server.port=8001 -management.endpoints.web.exposure.include=metrics,health,probes -management.endpoints.web.discovery.enabled=true +management.health.defaults.enabled=false +management.health.livenessstate.enabled=true +management.health.readinessstate.enabled=true + +management.endpoints.enabled-by-default=false +management.endpoint.health.enabled=true management.endpoint.health.show-details=always +management.endpoint.metrics.enabled=true +management.endpoints.web.exposure.include=metrics,health diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/cohort-metadata-access-server.json b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/cohort-metadata-access-server.json new file mode 100644 index 00000000000..d60e0f90e35 --- /dev/null +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/cohort-metadata-access-server.json @@ -0,0 +1,569 @@ +{ + "class": "OMAGServerConfig", + "versionId": "V2.0", + "localServerId": "9509651b-0b20-43cc-a9f9-85ea9e3674ee", + "localServerName": "cocoMDS1", + "localServerType": "Open Metadata and Governance Server", + "localServerURL": "https://localhost:9443", + "localServerUserId": "OMAGServer", + "maxPageSize": 1000, + "accessServicesConfig": [ + { + "class": "AccessServiceConfig", + "accessServiceId": 200, + "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", + "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetcatalog.admin.AssetCatalogAdmin", + "accessServiceName": "Asset Catalog", + "accessServiceFullName": "Asset Catalog OMAS", + "accessServiceURLMarker": "asset-catalog", + "accessServiceDescription": "Search and understand your assets", + "accessServiceWiki": "https://egeria-project.org/services/omas/asset-catalog/overview/", + "accessServiceOperationalStatus": "ENABLED", + "accessServiceOptions": { + "SupportedZones": [], + "DefaultZones": [], + "SupportedTypesForSearch": [ + "RelationalTable", + "TabularColumn", + "TabularFileColumn", + "RelationalColumn", + "GlossaryTerm", + "GlossaryCategory", + "Process", + "DataFile", + "Asset", + "Application", + "SoftwareServerCapability" + ] + } + }, + { + "class": "AccessServiceConfig", + "accessServiceId": 204, + "accessServiceDevelopmentStatus": "IN_DEVELOPMENT", + "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.assetmanager.admin.AssetManagerAdmin", + "accessServiceName": "Asset Manager", + "accessServiceFullName": "Asset Manager OMAS", + "accessServiceURLMarker": "asset-manager", + "accessServiceDescription": "Manage metadata from a third party asset manager", + "accessServiceWiki": "https://egeria-project.org/services/omas/asset-manager/overview/", + "accessServiceOperationalStatus": "ENABLED", + "accessServiceOptions": { + "SupportedZones": [], + "DefaultZones": [], + "SupportedTypesForSearch": [ + "RelationalTable", + "TabularColumn", + "TabularFileColumn", + "RelationalColumn", + "GlossaryTerm", + "GlossaryCategory", + "Process", + "DataFile", + "Asset", + "Application", + "SoftwareServerCapability" + ] + } + }, + { + "class": "AccessServiceConfig", + "accessServiceId": 210, + "accessServiceDevelopmentStatus": "TECHNICAL_PREVIEW", + "accessServiceAdminClass": "org.odpi.openmetadata.accessservices.datamanager.admin.DataManagerAdmin", + "accessServiceName": "Data Manager", + "accessServiceFullName": "Data Manager OMAS", + "accessServiceURLMarker": "data-manager", + "accessServiceDescription": "Capture changes to the data stores and data set managed by a data manager such as a database server, content manager or file system.", + "accessServiceWiki": "https://egeria-project.org/services/omas/data-manager/overview/", + "accessServiceOperationalStatus": "ENABLED" + } + ], + "repositoryServicesConfig": { + "class": "RepositoryServicesConfig", + "auditLogConnections": [ + { + "class": "Connection", + "headerVersion": 0, + "qualifiedName": "SLF4J- [, Information, Event, Decision, Action, Error, Exception, Security, Startup, Shutdown, Asset, Types, Cohort]", + "displayName": "SLF4J", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "e8303911-ba1c-4640-974e-c4d57ee1b310", + "qualifiedName": "Egeria:AuditLogDestinationConnector:SLF4J", + "displayName": "SLF4J Audit Log Destination Connector", + "description": "Connector supports logging of audit log messages to the slf4j logger ecosystem.", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.auditlogstore.slf4j.SLF4JAuditLogStoreProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.repositoryservices.connectors.stores.auditlogstore.OMRSAuditLogStore" + ], + "recognizedConfigurationProperties": [ + "supportedSeverities" + ] + }, + "configurationProperties": { + "supportedSeverities": [ + "Information", + "Startup", + "Shutdown" + ] + } + } + ], + "localRepositoryConfig": { + "class": "LocalRepositoryConfig", + "metadataCollectionId": "09e16fc0-5738-442c-a945-eb685db23b50", + "localRepositoryMode": "OPEN_METADATA_NATIVE", + "localRepositoryLocalConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "In Memory Local Repository Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "65cc9091-757f-4bcd-b937-426160be8bc2", + "qualifiedName": "Egeria:OMRSRepositoryConnector:InMemory", + "displayName": "In Memory OMRS Repository Connector", + "description": "Native open metadata repository connector that maps open metadata calls to a set of in memory hash maps - demo use only.", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.inmemory.repositoryconnector.InMemoryOMRSRepositoryConnectorProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSMetadataCollectionManager" + ] + } + }, + "localRepositoryRemoteConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "Local Repository Remote Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "75ea56d1-656c-43fb-bc0c-9d35c5553b9e", + "qualifiedName": "Egeria:OMRSRepositoryConnector:CohortMemberClient:REST", + "displayName": "REST Cohort Member Client Connector", + "description": "Cohort member client connector that provides access to open metadata located in a remote repository via REST calls.", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.rest.repositoryconnector.OMRSRESTRepositoryConnectorProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSMetadataCollectionManager" + ] + }, + "endpoint": { + "class": "Endpoint", + "headerVersion": 0, + "address": "https://localhost:9443/servers/cocoMDS1" + } + }, + "eventsToSaveRule": "ALL", + "eventsToSendRule": "ALL" + }, + "cohortConfigList": [ + { + "class": "CohortConfig", + "cohortName": "local-cohort", + "cohortRegistryConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "Cohort Registry Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "108b85fe-d7a8-45c3-9f88-742ac4e4fd14", + "qualifiedName": "Egeria:CohortRegistryConnector:File", + "displayName": "File-based Cohort Registry Store Connector", + "description": "Connector supports storing of the open metadata cohort registry in a file using JSON format.", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.repositoryservices.cohortregistrystore.file.FileBasedRegistryStoreProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.stores.cohortregistrystore.OMRSCohortRegistryStore" + ] + }, + "endpoint": { + "class": "Endpoint", + "headerVersion": 0, + "address": "./data/servers/cocoMDS1/cohorts/local-cohort.registrystore" + } + }, + "cohortOMRSRegistrationTopicConnection": { + "class": "VirtualConnection", + "headerVersion": 0, + "displayName": "Cohort OMRS Topic Connection for local-cohort OMRS Topic for registrations", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "qualifiedName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "displayName": "OMRS Topic Connector", + "description": "Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.", + "connectorProviderClassName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicListener", + "org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension", + "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopic" + ] + }, + "embeddedConnections": [ + { + "class": "EmbeddedConnection", + "headerVersion": 0, + "position": 0, + "displayName": "local-cohort OMRS Topic for registrations", + "embeddedConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "Kafka Event Bus Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "3851e8d0-e343-400c-82cb-3918fed81da6", + "qualifiedName": "Egeria:OpenMetadataTopicConnector:Kafka", + "displayName": "Apache Kafka Open Metadata Topic Connector", + "description": "Apache Kafka Open Metadata Topic Connector supports string based events over an Apache Kafka event bus.", + "supportedAssetTypeName": "KafkaTopic", + "expectedDataFormat": "PLAINTEXT", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.eventbus.topic.kafka.KafkaOpenMetadataTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.Connector", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent" + ], + "recognizedConfigurationProperties": [ + "producer", + "consumer", + "local.server.id", + "sleepTime", + "eventDirection" + ] + }, + "endpoint": { + "class": "Endpoint", + "headerVersion": 0, + "address": "local.openmetadata.repositoryservices.cohort.local-cohort.OMRSTopic.registration" + }, + "configurationProperties": { + "producer": { + "bootstrap.servers": "localhost:9092" + }, + "local.server.id": "2aea2a55-08b1-4e55-a6fb-0b352edab0de", + "consumer": { + "bootstrap.servers": "localhost:9092" + }, + "eventDirection": "inOut" + } + } + } + ] + }, + "cohortOMRSTypesTopicConnection": { + "class": "VirtualConnection", + "headerVersion": 0, + "displayName": "Cohort OMRS Topic Connection for local-cohort OMRS Topic for types", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "qualifiedName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "displayName": "OMRS Topic Connector", + "description": "Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.", + "connectorProviderClassName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicListener", + "org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension", + "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopic" + ] + }, + "embeddedConnections": [ + { + "class": "EmbeddedConnection", + "headerVersion": 0, + "position": 0, + "displayName": "local-cohort OMRS Topic for types", + "embeddedConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "Kafka Event Bus Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "3851e8d0-e343-400c-82cb-3918fed81da6", + "qualifiedName": "Egeria:OpenMetadataTopicConnector:Kafka", + "displayName": "Apache Kafka Open Metadata Topic Connector", + "description": "Apache Kafka Open Metadata Topic Connector supports string based events over an Apache Kafka event bus.", + "supportedAssetTypeName": "KafkaTopic", + "expectedDataFormat": "PLAINTEXT", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.eventbus.topic.kafka.KafkaOpenMetadataTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.Connector", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent" + ], + "recognizedConfigurationProperties": [ + "producer", + "consumer", + "local.server.id", + "sleepTime", + "eventDirection" + ] + }, + "endpoint": { + "class": "Endpoint", + "headerVersion": 0, + "address": "local.openmetadata.repositoryservices.cohort.local-cohort.OMRSTopic.types" + }, + "configurationProperties": { + "producer": { + "bootstrap.servers": "localhost:9092" + }, + "local.server.id": "2aea2a55-08b1-4e55-a6fb-0b352edab0de", + "consumer": { + "bootstrap.servers": "localhost:9092" + }, + "eventDirection": "inOut" + } + } + } + ] + }, + "cohortOMRSInstancesTopicConnection": { + "class": "VirtualConnection", + "headerVersion": 0, + "displayName": "Cohort OMRS Topic Connection for local-cohort OMRS Topic for instances", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "qualifiedName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "displayName": "OMRS Topic Connector", + "description": "Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.", + "connectorProviderClassName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicListener", + "org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension", + "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopic" + ] + }, + "embeddedConnections": [ + { + "class": "EmbeddedConnection", + "headerVersion": 0, + "position": 0, + "displayName": "local-cohort OMRS Topic for instances", + "embeddedConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "Kafka Event Bus Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "3851e8d0-e343-400c-82cb-3918fed81da6", + "qualifiedName": "Egeria:OpenMetadataTopicConnector:Kafka", + "displayName": "Apache Kafka Open Metadata Topic Connector", + "description": "Apache Kafka Open Metadata Topic Connector supports string based events over an Apache Kafka event bus.", + "supportedAssetTypeName": "KafkaTopic", + "expectedDataFormat": "PLAINTEXT", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.eventbus.topic.kafka.KafkaOpenMetadataTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.Connector", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent" + ], + "recognizedConfigurationProperties": [ + "producer", + "consumer", + "local.server.id", + "sleepTime", + "eventDirection" + ] + }, + "endpoint": { + "class": "Endpoint", + "headerVersion": 0, + "address": "local.openmetadata.repositoryservices.cohort.local-cohort.OMRSTopic.instances" + }, + "configurationProperties": { + "producer": { + "bootstrap.servers": "localhost:9092" + }, + "local.server.id": "2aea2a55-08b1-4e55-a6fb-0b352edab0de", + "consumer": { + "bootstrap.servers": "localhost:9092" + }, + "eventDirection": "inOut" + } + } + } + ] + }, + "cohortOMRSTopicProtocolVersion": "V1", + "eventsToProcessRule": "ALL" + } + ], + "enterpriseAccessConfig": { + "class": "EnterpriseAccessConfig", + "enterpriseMetadataCollectionName": "cocoMDS1 Enterprise Metadata Collection", + "enterpriseMetadataCollectionId": "df77a8e6-ef88-48a6-9462-ce5e9697c347", + "enterpriseOMRSTopicConnection": { + "class": "VirtualConnection", + "headerVersion": 0, + "displayName": "Enterprise OMRS Topic Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "qualifiedName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "displayName": "OMRS Topic Connector", + "description": "Provides access to the OMRS Topic that is used to exchange events between members of a cohort, or to notify Open Metadata Access Services (OMASs) of changes to metadata in the enterprise.", + "connectorProviderClassName": "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicListener", + "org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension", + "org.odpi.openmetadata.repositoryservices.connectors.omrstopic.OMRSTopic" + ] + }, + "embeddedConnections": [ + { + "class": "EmbeddedConnection", + "headerVersion": 0, + "position": 0, + "displayName": "Enterprise OMRS Events", + "embeddedConnection": { + "class": "Connection", + "headerVersion": 0, + "displayName": "Kafka Event Bus Connection", + "connectorType": { + "class": "ConnectorType", + "headerVersion": 0, + "type": { + "typeId": "954421eb-33a6-462d-a8ca-b5709a1bd0d4", + "typeName": "ConnectorType", + "typeVersion": 1, + "typeDescription": "A set of properties describing a type of connector." + }, + "guid": "ed8e682b-2fec-4403-b551-02f8c46322ef", + "qualifiedName": "Egeria:OpenMetadataTopicConnector:InMemory", + "displayName": "In Memory Open Metadata Topic Connector", + "description": "In Memory Open Metadata Topic Connector supports string based events over an in memory event bus.", + "connectorProviderClassName": "org.odpi.openmetadata.adapters.eventbus.topic.inmemory.InMemoryOpenMetadataTopicProvider", + "connectorFrameworkName": "Open Connector Framework (OCF)", + "connectorInterfaceLanguage": "Java", + "connectorInterfaces": [ + "org.odpi.openmetadata.frameworks.connectors.SecureConnectorExtension", + "org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent", + "java.lang.Runnable", + "org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic" + ] + }, + "endpoint": { + "class": "Endpoint", + "headerVersion": 0, + "address": "cocoMDS1.openmetadata.repositoryservices.enterprise.cocoMDS1.OMRSTopic" + }, + "configurationProperties": { + "local.server.id": "996892b6-7299-4046-8928-b6687a7818ee" + } + } + } + ] + }, + "enterpriseOMRSTopicProtocolVersion": "V1" + } + } +} \ No newline at end of file From 577cd70321076cc2d8982b112b734484554c4191 Mon Sep 17 00:00:00 2001 From: Ljupcho Palashevski Date: Mon, 31 Jul 2023 11:24:58 +0200 Subject: [PATCH 2/5] Comment out custom configuration due to test failures Signed-off-by: Ljupcho Palashevski --- .../src/test/resources/application-test.properties | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties index 48e88e16523..ae13efc9f1c 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties @@ -101,9 +101,9 @@ management.endpoints.health.probes.enabled=true management.endpoints.web.discovery.enabled=true -management.endpoint.health.group.custom.show-components=always -management.endpoint.health.group.custom.show-details=always -management.endpoint.health.group.custom.include=diskSpace,ping +#management.endpoint.health.group.custom.show-components=always +#management.endpoint.health.group.custom.show-details=always +#management.endpoint.health.group.custom.include=diskSpace,ping management.health.cassandra.enabled=false From c844846fa6fba65510bc7bc2e4ad0bb6836f2c66 Mon Sep 17 00:00:00 2001 From: Ljupcho Palashevski Date: Mon, 31 Jul 2023 19:42:40 +0200 Subject: [PATCH 3/5] Code enhancements and updates. Signed-off-by: Ljupcho Palashevski --- .../server-chassis-spring/README.md | 7 ++- .../server-chassis-spring/build.gradle | 5 +- .../serverchassis/springboot/OMAGServer.java | 56 +++++++++---------- .../config/OMAGServerProperties.java | 36 ++++++++++++ .../config/OMAGServicesConfiguration.java | 28 ++++++++++ .../main/resources/application-dev.properties | 22 ++++++++ .../src/main/resources/application.properties | 3 +- 7 files changed, 120 insertions(+), 37 deletions(-) create mode 100644 open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java create mode 100644 open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServicesConfiguration.java create mode 100644 open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/README.md b/open-metadata-implementation/server-chassis/server-chassis-spring/README.md index c061d1e4e33..08baa53c7ac 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/README.md +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/README.md @@ -21,10 +21,13 @@ To start the OMAG Server application manually using java from the project home, # Go to project home folder cd ../../../ # Execute java using -jar parameter starting the bootJar package and --omag.server.config setting the location of the OMAG server configuration file -java -jar open-metadata-implementation/server-chassis/server-chassis-spring/build/libs/server-chassis-spring-*-SNAPSHOT.jar --omag.server.config=file:open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-repository-server.json +java -jar open-metadata-implementation/server-chassis/server-chassis-spring/build/libs/server-chassis-spring-*-SNAPSHOT.jar --omag.server-config=file:open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-repository-server.json ``` Alternately, for development purpose in IDE such as IntelliJ you can use default Spring Boot run configuration. ### Application Properties -`omag.server.config` - The OMAG server configuration JSON file location. Notice the 'file:' prefix. With this, spring-boot loads the resource from a file on a given path on the filesystem. +| Property name | Environment variable | Description | +|--------------------|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| omag.server-config | OMAG_SERVER-CONFIG | The OMAGServerConfig document, JSON file location **(Required)**. Notice the 'file:' prefix. With this, spring-boot loads the resource from a file on a given path on the filesystem | +| omag.server-user | OMAG_SERVER-USER | The user name used to activate server using OMAG platform services - considered only when server security connector is enabled. If not provided default value 'system' is used | \ No newline at end of file diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle b/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle index ba187bb8c0b..d83c8590bda 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/build.gradle @@ -23,12 +23,13 @@ dependencies { implementation 'org.springframework.boot:spring-boot-actuator-autoconfigure' implementation 'org.springframework.boot:spring-boot-actuator' implementation 'org.springframework.boot:spring-boot-starter-tomcat' + implementation 'org.slf4j:slf4j-api' implementation 'com.fasterxml.jackson.core:jackson-databind' implementation 'com.fasterxml.jackson.core:jackson-annotations' implementation 'jakarta.servlet:jakarta.servlet-api' - implementation 'org.slf4j:slf4j-api' - annotationProcessor 'org.projectlombok:lombok' + implementation 'jakarta.validation:jakarta.validation-api' implementation 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' runtimeOnly 'io.micrometer:micrometer-registry-prometheus' runtimeOnly 'ch.qos.logback:logback-classic' diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java index d1dea1bf3d8..c73d950c277 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java @@ -6,20 +6,20 @@ import org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig; import org.odpi.openmetadata.platformservices.rest.SuccessMessageResponse; import org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices; +import org.odpi.openmetadata.serverchassis.springboot.config.OMAGServerProperties; import org.odpi.openmetadata.serverchassis.springboot.exception.OMAGServerActivationError; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.beans.factory.annotation.Value; import org.springframework.boot.ApplicationArguments; import org.springframework.boot.ApplicationRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.builder.SpringApplicationBuilder; +import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.context.ConfigurableApplicationContext; import org.springframework.context.event.ContextClosedEvent; import org.springframework.context.event.EventListener; -import org.springframework.core.io.Resource; import java.io.IOException; import java.nio.file.Files; import java.nio.file.Path; @@ -28,32 +28,31 @@ /** * OMAGServer provides the main program for the OMAG Server spring-boot based starter application. */ +@EnableConfigurationProperties(OMAGServerProperties.class) @SpringBootApplication( scanBasePackages = {"org.odpi.openmetadata"} ) public class OMAGServer implements ApplicationRunner { private static final Logger LOG = LoggerFactory.getLogger(OMAGServer.class); - private final OMAGServerOperationalServices operationalServices; - @Value("${omag.server.user:system}") - String omagServerUser; - @Value("${omag.server.config:#{null}}") - Resource omagServerConfigResource; private ObjectMapper objectMapper; + private final OMAGServerOperationalServices operationalServices; + private OMAGServerProperties serverProperties; + private OMAGServerConfig serverConfigDocument = null; private String serverName = null; - private OMAGServerConfig serverConfig = null; private final ConfigurableApplicationContext context; + /** * Constructor injecting the beans required. - * It also creates instance of OMAGServerOperationalServices. - * @see org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices + */ @Autowired - public OMAGServer(ObjectMapper objectMapper, ConfigurableApplicationContext ctx) { + public OMAGServer(ConfigurableApplicationContext ctx, ObjectMapper objectMapper,OMAGServerProperties omagServerProperties, OMAGServerOperationalServices operationalServices) { this.context = ctx; this.objectMapper = objectMapper; - this.operationalServices = new OMAGServerOperationalServices(); + this.serverProperties = omagServerProperties; + this.operationalServices = operationalServices; } /** @@ -78,7 +77,7 @@ public void run(ApplicationArguments args) { LOG.error("Server activation failed due to internal application error", e); /** * Any exception captured at this point means that there was problem activating the OMAG server, thus the application should be shut down. - * Since this is executed as application runner in a separate thread then main propagating the error further does not properly stop the application, instead we are explicitly exiting the application and jvm. + * Propagating the error further does not properly stop the application, instead we are explicitly exiting the application and jvm. //TODO: Check if this is the most optimal solution. */ System.exit(SpringApplication.exit(context)); } @@ -92,7 +91,7 @@ public void run(ApplicationArguments args) { private void onContextClosedEvent() { if (serverName != null) { LOG.info("Application stopped, deactivating server: {}", serverName); - operationalServices.deactivateTemporarilyServerList(omagServerUser, List.of(serverName)); + operationalServices.deactivateTemporarilyServerList(serverProperties.getServerUser(), List.of(serverName)); } } @@ -111,33 +110,28 @@ private void activateOMAGServerUsingPlatformServices() throws OMAGServerActivati LOG.debug("Activation started"); - if (omagServerConfigResource == null) { - LOG.info("Configuration loading failed, the cause is that configuration resource provided is null"); - throw new OMAGServerActivationError("Configuration failed, the cause is that configuration resource provided is null"); - } - try { - LOG.info("Configuration file: {} is being parsed", omagServerConfigResource.getFile()); - LOG.trace("{}", Files.readString(Path.of(omagServerConfigResource.getFile().getPath()))); - serverConfig = objectMapper.reader().readValue(omagServerConfigResource.getFile(), OMAGServerConfig.class); - serverName = serverConfig.getLocalServerName(); + LOG.info("Configuration file: {} is being parsed", serverProperties.getServerConfig().getFile()); + LOG.trace("{}", Files.readString(Path.of(serverProperties.getServerConfig().getFile().getPath()))); + serverConfigDocument = objectMapper.reader().readValue(serverProperties.getServerConfig().getFile(), OMAGServerConfig.class); + serverName = serverConfigDocument.getLocalServerName(); LOG.info("Configuration document for server: {} loaded successfully", serverName); } catch (IOException e) { - LOG.info("Configuration cannot be loaded from the resource provided"); + LOG.info("Configuration cannot be loaded from the resource provided - check application configuration"); throw new OMAGServerActivationError( - String.format("Configuration cannot be loaded from the resource provided"),e); + String.format("Configuration cannot be loaded from the resource provided - check application configuration"),e); } - if (serverConfig == null) { - LOG.info("Activation failed, the cause is that configuration is null"); - throw new OMAGServerActivationError("Activation failed the cause is that configuration is null"); + if (serverConfigDocument == null) { + LOG.info("Activation failed, the cause is that OMAGConfig document is null"); + throw new OMAGServerActivationError("Activation failed, the cause is that OMAGConfig document is null"); } - LOG.info("Sending activation request for server: {}", serverName); + LOG.info("Sending activation request for server: {} and user: {}", serverName, serverProperties.getServerUser()); SuccessMessageResponse response = operationalServices - .activateWithSuppliedConfig(omagServerUser.trim(), serverConfig.getLocalServerName(), serverConfig); + .activateWithSuppliedConfig(serverProperties.getServerUser().trim(), serverConfigDocument.getLocalServerName(), serverConfigDocument); if (response == null) { LOG.info("Activation has failed. The cause is that response is null"); @@ -150,7 +144,7 @@ private void activateOMAGServerUsingPlatformServices() throws OMAGServerActivati } if (response.getRelatedHTTPCode() == 200) { - LOG.info("Activation succeeded for server: {}", serverConfig.getLocalServerName()); + LOG.info("Activation succeeded for server: {}", serverConfigDocument.getLocalServerName()); } } diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java new file mode 100644 index 00000000000..fc9fedcf90d --- /dev/null +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java @@ -0,0 +1,36 @@ +/* SPDX-License-Identifier: Apache-2.0 */ +/* Copyright Contributors to the ODPi Egeria project. */ +package org.odpi.openmetadata.serverchassis.springboot.config; + +import jakarta.validation.constraints.NotNull; +import lombok.Getter; +import lombok.Setter; +import org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig; +import org.springframework.boot.context.properties.ConfigurationProperties; +import org.springframework.core.io.Resource; +import org.springframework.validation.annotation.Validated; + +/** + * This class provides validation support for OMAG specific application properties. + */ +@ConfigurationProperties(prefix = "omag") +@Getter +@Setter +@Validated +public class OMAGServerProperties { + + /** + * Configures the location of the OMAGServerConfig json document defined as Spring Resource. + * This property is required and cannot be null. + */ + @NotNull + private Resource serverConfig; + + /** + * Configures the username parameter used to activate the OMAG server instance using platform operational services. + * @see org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices#activateWithSuppliedConfig(String, String, OMAGServerConfig) + * Default value is set to 'system', can be overwritted + */ + private String serverUser = "system"; + +} diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServicesConfiguration.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServicesConfiguration.java new file mode 100644 index 00000000000..619d6fd5403 --- /dev/null +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServicesConfiguration.java @@ -0,0 +1,28 @@ +/* SPDX-License-Identifier: Apache-2.0 */ +/* Copyright Contributors to the ODPi Egeria project. */ +package org.odpi.openmetadata.serverchassis.springboot.config; + +import org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Primary; + + +/** + * This class provides configuration supporting OMAG related components required by the application. + */ +@Configuration +public class OMAGServicesConfiguration { + + /** + * Provides singleton bean instance of OMAGServerOperationalServices + * + * @return OMAGServerOperationalServices instance + * @see org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices + */ + @Primary + @Bean(name = {"platformOperationalServices"}) + public OMAGServerOperationalServices platformOperationalServices(){ + return new OMAGServerOperationalServices(); + } +} diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties new file mode 100644 index 00000000000..36406114a3c --- /dev/null +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties @@ -0,0 +1,22 @@ +# SPDX-License-Identifier: Apache-2.0 +# Copyright Contributors to the ODPi Egeria project. + +server.port=9443 +scan.packages=com.org.odpi.openmetadata.* +logging.level.org.odpi.openmetadata=error +logging.level.org.odpi.openmetadata.frameworks.auditlog=info +logging.level.org.odpi.openmetadata.serverchassis.springboot=info + +management.health.defaults.enabled=false +management.health.livenessstate.enabled=true +management.health.readinessstate.enabled=true + +management.endpoints.enabled-by-default=false +management.endpoint.health.enabled=true +management.endpoint.health.show-details=always +management.endpoint.metrics.enabled=true +management.endpoints.web.exposure.include=metrics,health + +omag.server-config=classpath:cohort-metadata-access-server.json +omag.server-user=system-npa + diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties index 35252661a4d..c28f5394dfc 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties @@ -2,7 +2,6 @@ # Copyright Contributors to the ODPi Egeria project. server.port=9443 -omag.server.config=classpath:cohort-metadata-access-server.json scan.packages=com.org.odpi.openmetadata.* logging.level.org.odpi.openmetadata=error logging.level.org.odpi.openmetadata.frameworks.auditlog=info @@ -16,4 +15,4 @@ management.endpoints.enabled-by-default=false management.endpoint.health.enabled=true management.endpoint.health.show-details=always management.endpoint.metrics.enabled=true -management.endpoints.web.exposure.include=metrics,health +management.endpoints.web.exposure.include=metrics,health \ No newline at end of file From f370877732e6aa47d81493dc0e5f6e8ba8bf8c5a Mon Sep 17 00:00:00 2001 From: Ljupcho Palashevski Date: Mon, 31 Jul 2023 19:43:56 +0200 Subject: [PATCH 4/5] Assembly pulling the jar from the new server-chassis-spring (omag-server) application, updated tests. Signed-off-by: Ljupcho Palashevski --- .../open-metadata-assemblies/build.gradle | 4 ++-- .../serverchassis/springboot/OMAGServer.java | 11 +++++------ .../serverchassis/springboot/OMAGServerTests.java | 13 +++++++++++-- .../src/test/resources/application-test.properties | 3 ++- 4 files changed, 20 insertions(+), 11 deletions(-) diff --git a/open-metadata-distribution/open-metadata-assemblies/build.gradle b/open-metadata-distribution/open-metadata-assemblies/build.gradle index 3a8db687c43..afa46bbc345 100644 --- a/open-metadata-distribution/open-metadata-assemblies/build.gradle +++ b/open-metadata-distribution/open-metadata-assemblies/build.gradle @@ -112,9 +112,9 @@ distributions { contents { into('server') { // Just the chassis - for backward compatibility - from { project(':open-metadata-implementation:platform-chassis:platform-chassis-spring').bootJar } + from { project(':open-metadata-implementation:server-chassis:server-chassis-spring').bootJar } rename { String fileName -> - fileName.replace("platform-chassis-spring", "server-chassis-spring") + fileName.replace("server-chassis-spring", "omag-server") } fileMode = 0755 } diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java index c73d950c277..2c2c31a6498 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java @@ -35,13 +35,12 @@ public class OMAGServer implements ApplicationRunner { private static final Logger LOG = LoggerFactory.getLogger(OMAGServer.class); - private ObjectMapper objectMapper; - private final OMAGServerOperationalServices operationalServices; - private OMAGServerProperties serverProperties; - private OMAGServerConfig serverConfigDocument = null; - private String serverName = null; private final ConfigurableApplicationContext context; - + private final ObjectMapper objectMapper; + private final OMAGServerOperationalServices operationalServices; + private final OMAGServerProperties serverProperties; + private OMAGServerConfig serverConfigDocument; + private String serverName; /** * Constructor injecting the beans required. diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServerTests.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServerTests.java index cb02a6f1a80..d94e7e3cea7 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServerTests.java +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServerTests.java @@ -4,28 +4,37 @@ import com.fasterxml.jackson.databind.ObjectMapper; import org.junit.jupiter.api.Test; +import org.odpi.openmetadata.platformservices.server.OMAGServerOperationalServices; +import org.odpi.openmetadata.serverchassis.springboot.config.OMAGServerProperties; import org.odpi.openmetadata.serverchassis.springboot.config.SSLEnvironmentConfiguration; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.autoconfigure.AutoConfigureAfter; +import org.springframework.boot.context.properties.EnableConfigurationProperties; import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.test.context.TestPropertySource; import static org.junit.jupiter.api.Assertions.assertNotNull; @SpringBootTest @AutoConfigureAfter(SSLEnvironmentConfiguration.class) +@TestPropertySource(properties = "spring.config.additional-location=classpath:application-test.properties") class OMAGServerTests { @Autowired ObjectMapper objectMapper; - @Autowired SSLEnvironmentConfiguration initializingBeanConfig; + @Autowired + OMAGServerOperationalServices operationalServices; + @Autowired + OMAGServerProperties omagServerProperties; @Test void contextLoads() { assertNotNull(objectMapper); assertNotNull(initializingBeanConfig); - + assertNotNull(omagServerProperties); + assertNotNull(operationalServices); } } diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties index ae13efc9f1c..3f4f174c776 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties @@ -1,8 +1,9 @@ # SPDX-License-Identifier: Apache-2.0 # Copyright Contributors to the ODPi Egeria project. +omag.server-config=classpath:metadata-access-server.json +omag.server-user=system-npa server.port=8001 -omag.server.config=classpath:metadata-access-server.json server.servlet.context-path=/actuator security.basic.enable: false From 16bf7ddd914b36953ecc81715557685c48d12834 Mon Sep 17 00:00:00 2001 From: Ljupcho Palashevski Date: Tue, 1 Aug 2023 16:36:23 +0200 Subject: [PATCH 5/5] Additional code enhancements, improved configuration loading, cleanup configurations, readme updates Signed-off-by: Ljupcho Palashevski --- .../server-chassis-spring/README.md | 29 +++++++++---------- .../serverchassis/springboot/OMAGServer.java | 27 ++++++++--------- .../config/OMAGServerProperties.java | 2 +- .../main/resources/application-dev.properties | 6 ++-- .../src/main/resources/application.properties | 2 -- .../cohort-metadata-access-server.json | 0 .../{ => samples}/integration-server.json | 4 +-- .../{ => samples}/metadata-access-server.json | 0 .../metadata-repository-server.json | 0 .../resources/application-test.properties | 2 +- 10 files changed, 32 insertions(+), 40 deletions(-) rename open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/{ => samples}/cohort-metadata-access-server.json (100%) rename open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/{ => samples}/integration-server.json (98%) rename open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/{ => samples}/metadata-access-server.json (100%) rename open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/{ => samples}/metadata-repository-server.json (100%) diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/README.md b/open-metadata-implementation/server-chassis/server-chassis-spring/README.md index 08baa53c7ac..6d9d5bc5a46 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/README.md +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/README.md @@ -5,29 +5,28 @@ ![egeria-content-status-in-development.png](..%2F..%2F..%2Fimages%2Fegeria-content-status-in-development.png) -This module is providing OMAG server chassis spring-boot based application that is able to launch single pre-configured OMAG server instance. +This module provides spring-boot based application that is able to launch single pre-configured OMAG server instance. ### Building the module with Gradle -To build current module from the project home folder execute following Gradle command: +To build the boot application jar from the current module use: -`./gradlew clean :open-metadata-implementation:server-chassis:server-chassis-spring:build` +`./gradlew clean build` -### Starting the application +### Starting the application locally -To start the OMAG Server application manually using java from the project home, execute following bash command: +You can run the application locally from this module with java using following command: ```bash -# Go to project home folder -cd ../../../ -# Execute java using -jar parameter starting the bootJar package and --omag.server.config setting the location of the OMAG server configuration file -java -jar open-metadata-implementation/server-chassis/server-chassis-spring/build/libs/server-chassis-spring-*-SNAPSHOT.jar --omag.server-config=file:open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-repository-server.json +java -jar build/libs/server-chassis-spring-*-SNAPSHOT.jar --omag.server-config=classpath:samples/metadata-repository-server.json --server.port=9080 --server.ssl.enabled=false ``` -Alternately, for development purpose in IDE such as IntelliJ you can use default Spring Boot run configuration. -### Application Properties +The command will run the application using provided parameters. For demo purpose we turn ssl off and run the application on http port 9080. -| Property name | Environment variable | Description | -|--------------------|----------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| omag.server-config | OMAG_SERVER-CONFIG | The OMAGServerConfig document, JSON file location **(Required)**. Notice the 'file:' prefix. With this, spring-boot loads the resource from a file on a given path on the filesystem | -| omag.server-user | OMAG_SERVER-USER | The user name used to activate server using OMAG platform services - considered only when server security connector is enabled. If not provided default value 'system' is used | \ No newline at end of file +### Configuration properties + +| Property name | Environment variable | | Description | +|--------------------|----------------------|:----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| omag.server-config | OMAG_SERVER-CONFIG | | The [OMAGServerConfig document](https://egeria-project.org/concepts/configuration-document/) json file location **(Required)**. Note the value should be spring Resource i.e. starting with `classpath:` or `file:` | +| server.port | SERVER_PORT | | Configures port used by the embedded Tomcat server | +| server.ssl.enabled | SERVER_SSL_ENABLED | | Configures if SSL should be enabled for the embedded Tomcat server | \ No newline at end of file diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java index 2c2c31a6498..814a7f61bc7 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/OMAGServer.java @@ -21,8 +21,6 @@ import org.springframework.context.event.ContextClosedEvent; import org.springframework.context.event.EventListener; import java.io.IOException; -import java.nio.file.Files; -import java.nio.file.Path; import java.util.List; /** @@ -101,7 +99,7 @@ private void onContextClosedEvent() { * The activation process requires OMAGServerConfig document. * @see org.odpi.openmetadata.adminservices.configuration.properties.OMAGServerConfig * - * The OMAGServerConfig document file location is provided as org.springframework.core.io.Resource and configured by application property ${omag.server.config} + * The OMAGServerConfig document location is provided as org.springframework.core.io.Resource and configured by application property `omag.server-config`. * * @throws OMAGServerActivationError */ @@ -110,21 +108,20 @@ private void activateOMAGServerUsingPlatformServices() throws OMAGServerActivati LOG.debug("Activation started"); try { - LOG.info("Configuration file: {} is being parsed", serverProperties.getServerConfig().getFile()); - LOG.trace("{}", Files.readString(Path.of(serverProperties.getServerConfig().getFile().getPath()))); - serverConfigDocument = objectMapper.reader().readValue(serverProperties.getServerConfig().getFile(), OMAGServerConfig.class); + LOG.info("Configuration {}", serverProperties.getServerConfig()); + serverConfigDocument = objectMapper.reader().readValue(serverProperties.getServerConfig().getInputStream(), OMAGServerConfig.class); + + if (serverConfigDocument == null) { + LOG.info("Activation failed, the cause is that the OMAGServerConfig document is null"); + throw new OMAGServerActivationError("Activation failed, the cause is that the OMAGServerConfig document is null"); + } + serverName = serverConfigDocument.getLocalServerName(); - LOG.info("Configuration document for server: {} loaded successfully", serverName); + LOG.info("Configuration document for server: {} - loaded successfully", serverName); } catch (IOException e) { - LOG.info("Configuration cannot be loaded from the resource provided - check application configuration"); + LOG.info("Configuration document cannot be loaded from the resource provided - check application configuration"); throw new OMAGServerActivationError( - String.format("Configuration cannot be loaded from the resource provided - check application configuration"),e); - } - - if (serverConfigDocument == null) { - LOG.info("Activation failed, the cause is that OMAGConfig document is null"); - throw new OMAGServerActivationError("Activation failed, the cause is that OMAGConfig document is null"); - + String.format("Configuration document cannot be loaded from the resource provided - check application configuration"),e); } LOG.info("Sending activation request for server: {} and user: {}", serverName, serverProperties.getServerUser()); diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java index fc9fedcf90d..b6b57f3ab3d 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/java/org/odpi/openmetadata/serverchassis/springboot/config/OMAGServerProperties.java @@ -20,7 +20,7 @@ public class OMAGServerProperties { /** - * Configures the location of the OMAGServerConfig json document defined as Spring Resource. + * Configures the location of the OMAGServerConfig json document defined as org.springframework.core.io.Resource * This property is required and cannot be null. */ @NotNull diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties index 36406114a3c..784c900e6d9 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application-dev.properties @@ -1,8 +1,6 @@ # SPDX-License-Identifier: Apache-2.0 # Copyright Contributors to the ODPi Egeria project. -server.port=9443 -scan.packages=com.org.odpi.openmetadata.* logging.level.org.odpi.openmetadata=error logging.level.org.odpi.openmetadata.frameworks.auditlog=info logging.level.org.odpi.openmetadata.serverchassis.springboot=info @@ -17,6 +15,6 @@ management.endpoint.health.show-details=always management.endpoint.metrics.enabled=true management.endpoints.web.exposure.include=metrics,health -omag.server-config=classpath:cohort-metadata-access-server.json -omag.server-user=system-npa +omag.server-config=classpath:samples/metadata-repository-server.json +omag.server-user=admin diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties index c28f5394dfc..a3cd33ebb36 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/application.properties @@ -1,8 +1,6 @@ # SPDX-License-Identifier: Apache-2.0 # Copyright Contributors to the ODPi Egeria project. -server.port=9443 -scan.packages=com.org.odpi.openmetadata.* logging.level.org.odpi.openmetadata=error logging.level.org.odpi.openmetadata.frameworks.auditlog=info logging.level.org.odpi.openmetadata.serverchassis.springboot=info diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/cohort-metadata-access-server.json b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/cohort-metadata-access-server.json similarity index 100% rename from open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/cohort-metadata-access-server.json rename to open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/cohort-metadata-access-server.json diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/integration-server.json b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/integration-server.json similarity index 98% rename from open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/integration-server.json rename to open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/integration-server.json index 87d56c420ef..a14497d78a4 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/integration-server.json +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/integration-server.json @@ -4,7 +4,7 @@ "localServerId": "0aac3308-bae9-43e9-8743-2cac4350fe3f", "localServerName": "cocoDIS1", "localServerType": "Open Metadata and Governance Server", - "localServerURL": "https://localhost:9444", + "localServerURL": "https://localhost:9445", "localServerUserId": "OMAGServer", "maxPageSize": 1000, "repositoryServicesConfig": { @@ -130,7 +130,7 @@ } ], "omagserverName": "cocoMDS1", - "omagserverPlatformRootURL": "https://localhost:9443" + "omagserverPlatformRootURL": "https://localhost:9444" } ] } \ No newline at end of file diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-access-server.json b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/metadata-access-server.json similarity index 100% rename from open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-access-server.json rename to open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/metadata-access-server.json diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-repository-server.json b/open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/metadata-repository-server.json similarity index 100% rename from open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/metadata-repository-server.json rename to open-metadata-implementation/server-chassis/server-chassis-spring/src/main/resources/samples/metadata-repository-server.json diff --git a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties index 3f4f174c776..2d730e29603 100644 --- a/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties +++ b/open-metadata-implementation/server-chassis/server-chassis-spring/src/test/resources/application-test.properties @@ -1,6 +1,6 @@ # SPDX-License-Identifier: Apache-2.0 # Copyright Contributors to the ODPi Egeria project. -omag.server-config=classpath:metadata-access-server.json +omag.server-config=classpath:samples/metadata-repository-server.json omag.server-user=system-npa server.port=8001