Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify and improve integration development #7831

Merged
merged 7 commits into from
Aug 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ egeria-lineage-repositories/**
/OpenConnectorsArchive.json
/OpenMetadataTypes.json
/SimpleAPICatalog.json
/SimpleCatalog.json
/SimpleDataCatalog.json
/SimpleEventCatalog.json
/SimpleGovernanceCatalog.json
Expand Down
2 changes: 2 additions & 0 deletions content-packs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ These archives are used in the *Development labs* which are part of the [Open Me

* **SimpleGovernanceCatalog** - A glossary term linked to metadata elements in the API, Event, Data catalogs.

There is also **SimpleCatalog** that rolls up the content of the four catalogs into a single content pack for use in other scenarios.

----
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Copyright Contributors to the ODPi Egeria project.
2 changes: 1 addition & 1 deletion content-packs/SimpleAPICatalog.json

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions content-packs/SimpleCatalog.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content-packs/SimpleDataCatalog.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content-packs/SimpleEventCatalog.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content-packs/SimpleGovernanceCatalog.json

Large diffs are not rendered by default.

17 changes: 12 additions & 5 deletions open-metadata-distribution/omag-server-platform/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,18 @@ distributions {
fileMode = 0755
}
into('platform/extra') {
// Identify how
from { "$rootProject.projectDir/open-metadata-distribution/omag-server-platform/docs" }
rename { String fileName ->
fileName.replace("extraREADME.md", "README.md")
}
// Identify how to add new libs
from { "$rootProject.projectDir/open-metadata-distribution/omag-server-platform/docs/extra" }
fileMode = 0755
}
into('platform/lib') {
// Identify how to add new libs
from { "$rootProject.projectDir/open-metadata-distribution/omag-server-platform/docs/lib" }
fileMode = 0755
}
into('platform') {
// Identify how the platform is started
from { "$rootProject.projectDir/open-metadata-distribution/omag-server-platform/docs/platform" }
fileMode = 0755
}
into('platform/lib') {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<mxfile host="Electron" modified="2023-08-16T19:19:51.299Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="wrvxaWCo8BjC61uZpzAH" version="21.6.8" type="device">
<mxfile host="Electron" modified="2023-08-22T18:10:58.620Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.6.8 Chrome/114.0.5735.289 Electron/25.5.0 Safari/537.36" etag="Pwtll1Drx0s40xBhsWB5" version="21.6.8" type="device">
<diagram name="omag-server-platform" id="Dl-jfd4jh1dtPhGWNfl4">
<mxGraphModel dx="1343" dy="865" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<mxGraphModel dx="1194" dy="775" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="fCwrAneLEY61tobPp7tf-0" />
<mxCell id="fCwrAneLEY61tobPp7tf-1" parent="fCwrAneLEY61tobPp7tf-0" />
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->

# Connector Libraries

This directory contains the jar files of the standard connectors supplied with Egeria.
These connectors are described in Egeria's [Connector Catalog](https://egeria-project.org/connectors/).

----
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Copyright Contributors to the ODPi Egeria project.




Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
<!-- Copyright Contributors to the ODPi Egeria project. -->

# OMAG Server Platform

The omag-server-platform.jar file holds the main runtime for Egeria, To start the
platform, enter:

```bash
java -Dloader.path=lib,extra omag-server-platform*.jar
```

You will see the platform logo plus other messages describing its startup configuration.

```bash
Project Egeria - Open Metadata and Governance
____ __ ___ ___ ______ _____ ____ _ _ ___
/ __ \ / |/ // | / ____/ / ___/ ___ ____ _ __ ___ ____ / _ \ / / __ / / / _ /__ ____ _ _
/ / / // /|_/ // /| | / / __ \__ \ / _ \ / __/| | / // _ \ / __/ / /_/ // // | / _\ / /_ / | / _// || |
/ /_/ // / / // ___ |/ /_/ / ___/ // __// / | |/ // __// / / __ // // / \ / /_ / _// / // / / / / /
\____//_/ /_//_/ |_|\____/ /____/ \___//_/ |___/ \___//_/ /_/ /_/ \__/\//___//_/ \__//_/ /_/ /_/

:: Powered by Spring Boot (v3.1.1) ::

'date time' INFO 46460 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Starting OMAGServerPlatform using Java 17.0.6 with PID 46460 ('jar file name' started by 'user' in 'directory')
'date time' INFO 46460 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : No active profile set, falling back to 1 default profile: "default"
'date time' INFO 46460 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat initialized with port(s): 9443 (https)
'date time' INFO 46460 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Working directory is: 'directory name'
'date time' WARN 46460 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Java trust store 'javax.net.ssl.trustStore' is null - this is needed by Tomcat - using 'server.ssl.trust-store'
'date time' INFO 46460 --- [ main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 9443 (https) with context path ''
'date time' INFO 46460 --- [ main] o.o.o.s.springboot.OMAGServerPlatform : Started OMAGServerPlatform in 8.192 seconds (process running for 8.927)
'date time' No OMAG servers listed in startup configuration
'date time' OMAG server platform ready for more configuration

```
Once the "platform ready" message is displayed, its REST APIs are active and you can configure servers and services within them.

* [OMAG Server Platform](https://egeria-project.org/concepts/omag-server-platform/) describes how the platform works.
* [Configuring the OMAG Server Platform](https://egeria-project.org/guides/admin/configuring-the-omag-server-platform/) describes the different configuration options available for the OMAG Server Platform.

----
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
Copyright Contributors to the ODPi Egeria project.




Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package org.odpi.openmetadata.adapters.connectors.resource.jdbc;

import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;

Expand Down Expand Up @@ -103,6 +104,7 @@ public JDBCResourceConnectorProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.STABLE);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorTypeDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@


import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
import org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicProvider;

Expand Down Expand Up @@ -72,6 +73,7 @@ public InMemoryOpenMetadataTopicProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.STABLE);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
import org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopic;
import org.odpi.openmetadata.repositoryservices.connectors.openmetadatatopic.OpenMetadataTopicProvider;
Expand Down Expand Up @@ -97,6 +98,7 @@ public KafkaOpenMetadataTopicProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.STABLE);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package org.odpi.openmetadata.adapters.connectors.integration.apacheatlas;

import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
import org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider;

Expand Down Expand Up @@ -89,6 +90,7 @@ public ApacheAtlasIntegrationProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.TECHNICAL_PREVIEW);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -827,7 +827,7 @@ protected List<String> getAtlasStringArray(Map<String, Object> attributes,
/**
* Add a property from Apache Atlas to Egeria's additionalProperties map since it has nowhere else to go.
*
* @param atlasAttributes all of the attributes retrieved from Apache Atlas
* @param atlasAttributes all the attributes retrieved from Apache Atlas
* @param skipPropertyNames names of the properties that have already been extracted
* @return additionalProperties populated with properties from Apache Atlas
*/
Expand Down Expand Up @@ -866,7 +866,7 @@ protected Map<String, String> addRemainingPropertiesToAdditionalProperties(Map<S
* Since the property is a map of properties, each entry is added as separate property using a dotted
* notation mapPropertyName.mapPropertyKey.mapPropertyValue.
*
* @param atlasAttributes all of the attributes retrieved from Apache Atlas
* @param atlasAttributes all the attributes retrieved from Apache Atlas
* @param propertyName name of the property to extract
* @param egeriaAdditionalProperties additionalProperties to map to populate
*/
Expand Down Expand Up @@ -896,7 +896,7 @@ protected void addStringArrayToAdditionalProperties(Map<String, Object> atlasAtt
* Since the property is a map of properties, each entry is added as separate property using a dotted
* notation mapPropertyName.mapPropertyKey.mapPropertyValue.
*
* @param atlasAttributes all of the attributes retrieved from Apache Atlas
* @param atlasAttributes all the attributes retrieved from Apache Atlas
* @param propertyName name of the property to extract
* @param egeriaAdditionalProperties additionalProperties to map to populate
*/
Expand All @@ -923,7 +923,7 @@ protected void addPropertyMapToAdditionalProperties(Map<String, Object> atlasAtt


/**
* Synchronize all of the data set entities from Apache Atlas to the open metadata ecosystem.
* Synchronize all the data set entities from Apache Atlas to the open metadata ecosystem.
*
* @param atlasTypeName name of the type of entity to synchronize from Apache Atlas
* @param egeriaTypeName name of the type of entity to synchronize to the open metadata ecosystem
Expand Down Expand Up @@ -1189,7 +1189,7 @@ protected DataAssetProperties getDataAssetProperties(AtlasEntity atlasEntity,

dataAssetProperties.setTypeName(egeriaTypeName);
dataAssetProperties.setDeployedImplementationType(atlasEntity.getTypeName());
dataAssetProperties.setQualifiedName("Apache Atlas" + ":" + atlasEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, atlasQualifiedNamePropertyName));
dataAssetProperties.setQualifiedName(myContext.getMetadataSourceQualifiedName() + ":" + atlasEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, atlasQualifiedNamePropertyName));
dataAssetProperties.setTechnicalName(getAtlasStringProperty(attributes, atlasNamePropertyName));
dataAssetProperties.setTechnicalDescription(getAtlasStringProperty(attributes, atlasDescriptionPropertyName));
dataAssetProperties.setDisplayName(getAtlasStringProperty(attributes, atlasDisplayNamePropertyName));
Expand Down Expand Up @@ -1220,7 +1220,7 @@ protected DataAssetProperties getEgeriaDataFileProperties(AtlasEntity atlasFSPat

dataAssetProperties.setTypeName(egeriaTypeName);
dataAssetProperties.setDeployedImplementationType(atlasFSPathEntity.getTypeName());
dataAssetProperties.setQualifiedName("Apache Atlas" + ":" + atlasFSPathEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, atlasQualifiedNamePropertyName));
dataAssetProperties.setQualifiedName(myContext.getMetadataSourceQualifiedName() + ":" + atlasFSPathEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, atlasQualifiedNamePropertyName));
dataAssetProperties.setTechnicalName(getAtlasStringProperty(attributes, atlasNamePropertyName));
dataAssetProperties.setTechnicalDescription(getAtlasStringProperty(attributes, atlasDescriptionPropertyName));
dataAssetProperties.setDisplayName(getAtlasStringProperty(attributes, atlasDisplayNamePropertyName));
Expand Down Expand Up @@ -1254,7 +1254,7 @@ protected ProcessProperties getProcessProperties(AtlasEntity atlasEntity,

processProperties.setTypeName(egeriaTypeName);
processProperties.setDeployedImplementationType(atlasEntity.getTypeName());
processProperties.setQualifiedName("Apache Atlas" + ":" + atlasEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, atlasQualifiedNamePropertyName));
processProperties.setQualifiedName(myContext.getMetadataSourceQualifiedName() + ":" + atlasEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, atlasQualifiedNamePropertyName));
processProperties.setTechnicalName(getAtlasStringProperty(attributes, atlasNamePropertyName));
processProperties.setTechnicalDescription(getAtlasStringProperty(attributes, atlasDescriptionPropertyName));
processProperties.setDisplayName(getAtlasStringProperty(attributes, atlasDisplayNamePropertyName));
Expand Down Expand Up @@ -1287,7 +1287,7 @@ protected SchemaAttributeProperties getSchemaAttributeProperties(AtlasEntity a
Map<String, Object> attributes = atlasEntity.getAttributes();

schemaAttributeProperties.setTypeName(egeriaSchemaAttributeTypeName);
schemaAttributeProperties.setQualifiedName("Apache Atlas" + ":" + atlasEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, "qualifiedName"));
schemaAttributeProperties.setQualifiedName(myContext.getMetadataSourceQualifiedName() + ":" + atlasEntity.getTypeName() + ":" + getAtlasStringProperty(attributes, "qualifiedName"));

schemaAttributeProperties.setDisplayName(getAtlasStringProperty(attributes, "name") );
schemaAttributeProperties.setDescription(getAtlasStringProperty(attributes, "description"));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ class BasicFilesMonitorIntegrationProviderBase extends IntegrationConnectorProvi
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.TECHNICAL_PREVIEW);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.STABLE);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

import org.odpi.openmetadata.adapters.connectors.integration.jdbc.transfer.customization.TransferCustomizations;
import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
import org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider;

Expand Down Expand Up @@ -76,6 +77,7 @@ public JDBCIntegrationConnectorProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.TECHNICAL_PREVIEW);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package org.odpi.openmetadata.adapters.connectors.integration.kafka;

import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
import org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider;

Expand Down Expand Up @@ -78,6 +79,7 @@ public KafkaMonitorIntegrationProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.STABLE);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
package org.odpi.openmetadata.adapters.connectors.integration.openapis;

import org.odpi.openmetadata.frameworks.auditlog.AuditLogReportingComponent;
import org.odpi.openmetadata.frameworks.auditlog.ComponentDevelopmentStatus;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
import org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorProvider;

Expand Down Expand Up @@ -78,6 +79,7 @@ public OpenAPIMonitorIntegrationProvider()
AuditLogReportingComponent componentDescription = new AuditLogReportingComponent();

componentDescription.setComponentId(connectorComponentId);
componentDescription.setComponentDevelopmentStatus(ComponentDevelopmentStatus.TECHNICAL_PREVIEW);
componentDescription.setComponentName(connectorQualifiedName);
componentDescription.setComponentDescription(connectorDescription);
componentDescription.setComponentWikiURL(connectorWikiPage);
Expand Down
Loading
Loading