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

Create framework services #7261

Merged
merged 11 commits into from
Dec 30, 2022
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ This file recognizes the people who have make an important contribution to Egeri
| Sachin Naik | sachin.naik@ibm.com |
| Liz McIntosh | liz.mcintosh@sas.com |
| Dan Wolfson | dan.wolfson@pdr-associates.com |
| Juergen Helmelt | juergenhemelt |
| Cristian-Mihai Iliescu | cristianmihaiiliescu@gmail.com |
| Juergen Hemelt | juergenhemelt |
| Cristian-Mihai Iliescu | cristianmihaiiliescu@gmail.com |



Expand Down
2 changes: 1 addition & 1 deletion content-packs/OpenMetadataTypes.json

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion open-metadata-implementation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ platform and clients.

The packages are as follows:


* **[access-services](access-services)** - the access services provide domain-specific services for data tools, engines
and platforms that for maintaining and retrieving metadata. The access services run in either the metadata access
point server or metadata server on the OMAG Server Platform. They call the repository services
Expand All @@ -53,6 +52,9 @@ as connectors, discovery services and governance actions. These
components provide much of the customization offered by the open metadata and governance
implementation.

* **[framework-services](framework-services)** - the framework services provide REST APIs to support the interfaces
defined in the frameworks. they are incorporated into the [access services](access-services).

* **[governance-servers](governance-servers)** - the governance server services provide the
server frameworks that support the different types of governance servers that can run in the OMAG Server Platform.

Expand Down
43 changes: 19 additions & 24 deletions open-metadata-implementation/access-services/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,9 @@ asset managers.
asset information, including schemas, profiles, policies and lineage
information with a third party asset manager. Typical examples of asset managers include
data catalogs that are managing metadata for a collection of data assets for a
data-serving solution.
data-serving solution. The asset manager is also called by the
[Lineage Integrator OMIS](../integration-services/lineage-integrator) to capture design lineage
from data engines and other processing services.

* **[asset-owner](asset-owner)** - manage metadata and feedback for owned assets.

Expand All @@ -62,14 +64,15 @@ This information forms a key part of asset lineage.

* **[data-manager](data-manager)** - exchange metadata with a data manager.

The Data Manager OMAS provides an integration point to enable technologies that manage collections of data
such as database servers,
file systems, file managers and content managers to publish metadata to the metadata
The Data Manager OMAS provides technology-specific APIs to enable technologies that manage collections of data
such as database servers, file systems, file managers and content managers to publish metadata to the metadata
repositories about the changing structures and content stored in the data platform.
It is typically called from the
[Database Integrator OMIS](../integration-services/database-integrator) and
[Files Integrator OMIS](../integration-services/files-integrator)
integration services.
It is called from the
[API Integrator OMIS](../integration-services/api-integrator),
[Database Integrator OMIS](../integration-services/database-integrator),
[Display Integrator OMIS](../integration-services/display-integrator),
[Files Integrator OMIS](../integration-services/files-integrator) and
[Topic Integrator OMIS](../integration-services/topic-integrator).


* **[data-privacy](data-privacy)** - support a data privacy officer.
Expand All @@ -92,7 +95,7 @@ It is designed for data science and analytics management tools.
These models may come from tools or be part of a packaged standard.
This content is useful for governance, system integration and software development.

* **[dev-ops](dev-ops)** - manage metadata for a devOps pipeline.
* **[dev-ops](dev-ops)** - manage metadata for a DevOps pipeline.

The DevOps OMAS provides services for a DevOps pipeline to query and maintain metadata about systems, processes and
software components that are being deployed into the information landscape.
Expand All @@ -104,15 +107,14 @@ that support the business.
models for an organization. It is designed for architecture tools. It is able to support the
definition and management of a digital service through concept to deployment.

* **[digital-service](digital-service)** - manage metadata for a the Egeria Digital Services lifecycle.
* **[digital-service](digital-service)** - manage metadata for digital services and products.

The Digital Service OMAS provides services for a managing the lifecycle of an Egeria Digital Service.
The Digital Service OMAS provides services for a managing the lifecycle of a Digital Service and any associated products.

* **[discovery-engine](discovery-engine)** - manage metadata for metadata discovery services.

The Discovery Engine OMAS provides an API for a discovery engine to access and store
metadata from an open
metadata repository (or open metadata repository cohort).
metadata about a digital resource, its schema and the data it stores.

* **[governance-engine](governance-engine)** - manage metadata for an operational governance engine.

Expand Down Expand Up @@ -170,17 +172,10 @@ invalid licensing, job failures, and many more.
The Stewardship Action OMAS also enables the review and triage of the exceptions,
simple remediation and status reporting.

* **[subject-area](subject-area)** - develop a definition of a subject area including glossary
terms, reference data and rules.

The Subject Area OMAS is for tools that support subject matter experts
who are defining glossaries, reference data and rules around data for a specific
subject area, such as "customer data". It supports the development of a comprehensive
definition of the subject area and the standards that support it.
These definitions can then be folded into the Governance Program,
and used by Asset Owner's to improve the findability and understandability
of their assets by linking their asset's structure to relevant parts of
the subject area definition.
* **[subject-area](subject-area)** - develop a glossary.

The Subject Area OMAS is for tools that support subject-matter experts
who are defining glossaries for a specific subject area, such as "customer data".

## Using the OMASs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ dependencies {
implementation project(':open-metadata-implementation:common-services:ffdc-services')
implementation project(':open-metadata-implementation:adapters:open-connectors:rest-client-connectors:rest-client-connectors-api')
implementation project(':open-metadata-implementation:repository-services:repository-services-apis')
implementation project(':open-metadata-implementation:common-services:ocf-metadata-management:ocf-metadata-api')
implementation project(':open-metadata-implementation:common-services:ocf-metadata-management:ocf-metadata-client')
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-api')
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-client')
implementation project(':open-metadata-implementation:frameworks:audit-log-framework')
implementation 'org.springframework:spring-core'
testImplementation 'org.mockito:mockito-core'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ dependencies {
implementation project(':open-metadata-implementation:common-services:repository-handler')
implementation project(':open-metadata-implementation:frameworks:open-connector-framework')
implementation project(':open-metadata-implementation:common-services:ffdc-services')
implementation project(':open-metadata-implementation:common-services:ocf-metadata-management:ocf-metadata-handlers')
implementation project(':open-metadata-implementation:framework-services:ocf-metadata-management:ocf-metadata-handlers')
implementation project(':open-metadata-implementation:common-services:metadata-security:metadata-security-server')
implementation 'org.slf4j:slf4j-api'
implementation 'org.springframework:spring-core'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
{
"info": {
"_postman_id": "9d66711a-e01c-4fe2-9dd5-3eb83e6e5e87",
"_postman_id": "35153113-aeaa-4be4-b693-98194003a44c",
"name": "Egeria-asset-consumer-omas",
"description": "This collection documents the the REST APIs for AssetConsumer OMAS.",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "19267272"
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"item": [
{
Expand Down Expand Up @@ -296,7 +295,7 @@
],
"body": {
"mode": "raw",
"raw": "DropFootWeek1",
"raw": "{\n \"class\" : \"NameRequestBody\",\n \"name\" : \"DropFoot\"\n}",
"options": {
"raw": {
"language": "text"
Expand Down Expand Up @@ -348,10 +347,10 @@
],
"body": {
"mode": "raw",
"raw": ".*",
"raw": "{\n \"class\" : \"SearchStringRequestBody\",\n \"searchString\" : \".*.\"\n}",
"options": {
"raw": {
"language": "text"
"language": "json"
}
}
},
Expand Down Expand Up @@ -400,10 +399,10 @@
],
"body": {
"mode": "raw",
"raw": "{\n\t\"class\" : \"CommentProperties\",\n\t\"isPublic\" : \"true\",\n\t\"commentType\" : \"STANDARD_COMMENT\",\n\t\"commentText\" : \"This is the comment on the asset\"\n}"
"raw": "{\n\t\"class\" : \"CommentRequestBody\",\n\t\"isPublic\" : \"true\",\n\t\"commentType\" : \"STANDARD_COMMENT\",\n\t\"commentText\" : \"This is the comment on the asset\"\n}"
},
"url": {
"raw": "{{baseURL}}/servers/{{server}}/open-metadata/access-services/asset-consumer/users/{{user}}/assets/{{guid}}/comments",
"raw": "{{baseURL}}/servers/{{server}}/open-metadata/access-services/asset-consumer/users/{{user}}/assets/{{assetGUID}}/comments",
"host": [
"{{baseURL}}"
],
Expand All @@ -416,7 +415,7 @@
"users",
"{{user}}",
"assets",
"{{guid}}",
"{{assetGUID}}",
"comments"
]
},
Expand All @@ -438,7 +437,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n\t\"class\" : \"CommentProperties\",\n\t\"isPublic\" : \"true\",\n\t\"commentType\" : \"STANDARD_COMMENT\",\n\t\"commentText\" : \"This is the comment on the asset\"\n}"
"raw": "{\n\t\"class\" : \"CommentRequestBody\",\n\t\"isPublic\" : \"true\",\n\t\"commentType\" : \"STANDARD_COMMENT\",\n\t\"commentText\" : \"This is the comment on the asset\"\n}"
},
"url": {
"raw": "{{baseURL}}/servers/{{server}}/open-metadata/access-services/asset-consumer/users/{{user}}/assets/{{assetGUID}}/comments/{{guid}}/update",
Expand Down Expand Up @@ -514,7 +513,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n\t\"class\" : \"CommentProperties\",\n\t\"isPublic\" : \"true\",\n\t\"commentType\" : \"ANSWER\",\n\t\"commentText\" : \"This is the response to your comment\"\n}"
"raw": "{\n\t\"class\" : \"CommentRequestBody\",\n\t\"isPublic\" : \"true\",\n\t\"commentType\" : \"ANSWER\",\n\t\"commentText\" : \"This is the response to your comment\"\n}"
},
"url": {
"raw": "{{baseURL}}/servers/{{server}}/open-metadata/access-services/asset-consumer/users/{{user}}/assets/{{assetGUID}}/comments/{{guid}}/replies",
Expand Down Expand Up @@ -554,7 +553,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n\t\"class\" : \"RatingProperties\",\n\t\"isPublic\" : \"true\",\n\t\"starRating\" : \"ONE_STAR\",\n\t\"review\" : \"This is the optional review text.\"\n}"
"raw": "{\n\t\"class\" : \"RatingRequestBody\",\n\t\"isPublic\" : \"true\",\n\t\"starRating\" : \"ONE_STAR\",\n\t\"review\" : \"This is the optional review text.\"\n}"
},
"url": {
"raw": "{{baseURL}}/servers/{{server}}/open-metadata/access-services/asset-consumer/users/{{user}}/assets/{{assetGUID}}/ratings",
Expand Down Expand Up @@ -852,7 +851,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n\t\"class\" : \"InformalTagProperties\",\n\t\"isPublic\" : \"true\",\n\t\"tagName\" : \"clinical-measurements\",\n\t\"tagDescription\" : \"Data collected from patients, medical staff and equipment that measure an aspect of the treatment.\"\n}"
"raw": "{\n\t\"class\" : \"TagRequestBody\",\n\t\"isPrivateTag\" : \"true\",\n\t\"name\" : \"clinical-measurements\",\n\t\"description\" : \"Data collected from patients, medical staff and equipment that measure an aspect of the treatment.\"\n}"
},
"url": {
"raw": "{{baseURL}}/servers/{{server}}/open-metadata/access-services/asset-consumer/users/{{user}}/tags",
Expand Down Expand Up @@ -1109,10 +1108,10 @@
],
"body": {
"mode": "raw",
"raw": ".*",
"raw": "{\n \"class\" : \"SearchStringRequestBody\",\n \"searchString\" : \".*.\"\n}",
"options": {
"raw": {
"language": "text"
"language": "json"
}
}
},
Expand Down Expand Up @@ -1161,10 +1160,10 @@
],
"body": {
"mode": "raw",
"raw": ".*",
"raw": "{\n \"class\" : \"SearchStringRequestBody\",\n \"searchString\" : \".*.\"\n}",
"options": {
"raw": {
"language": "text"
"language": "json"
}
}
},
Expand Down Expand Up @@ -1239,10 +1238,10 @@
],
"body": {
"mode": "raw",
"raw": "DropFootWeek1",
"raw": "{\n \"class\" : \"NameRequestBody\",\n \"name\" : \"DropFoot\"\n}",
"options": {
"raw": {
"language": "text"
"language": "json"
}
}
},
Expand Down Expand Up @@ -1291,10 +1290,10 @@
],
"body": {
"mode": "raw",
"raw": ".*",
"raw": "{\n \"class\" : \"SearchStringRequestBody\",\n \"searchString\" : \".*.\"\n}",
"options": {
"raw": {
"language": "text"
"language": "json"
}
}
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
/* Copyright Contributors to the ODPi Egeria project. */
package org.odpi.openmetadata.accessservices.assetconsumer.api;

import org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType;
import org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.CommentType;
import org.odpi.openmetadata.frameworks.connectors.properties.beans.StarRating;
import org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException;
import org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException;
import org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException;


/**
* AssetConsumerFeedbackInterface supports the ability to add and remove feedback for an asset.
* This feedback may be in the form of ratings, likes and comments.
Expand Down
Loading