Create framework services #7261

mandy-chessell · 2022-12-30T12:08:29Z

Description

This PR has the following content:

Move OCF Metadata Management and GAF Metadata Management from common-services to a new module called framework-services. This identifies that these modules are associated with the frameworks and leaves all of the modules under common-services as internal Java libraries.
Bug fixes to Asset Consumer OMAS and Asset Owner OMAS
Fixes to Digital Service and Solution Component related types
Updates to readmes and other documentation

Related Issue(s)

#6526 refers to types that are updated by this PR.

Testing

Both FVT and additional test using postman.

Release Notes & Documentation

The type changes need to go into the relase docs (work in progress)

Additional notes

This PR is needed by @dwolfson for the python client work.

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

dwolfson

This should both support easier reuse of general services (in framework services) and addresses issues discovered as I worked on the python client.

sonatype-lift · 2022-12-30T14:12:47Z

...c/main/java/org/odpi/openmetadata/accessservices/assetconsumer/fvt/CommentLifecycleTest.java

+     * @param isPublic should this be a private comment or not?
+     * @param activityName name of the test case
+     * @param commentTypeName name of comment in reporting output
+     * @return GUID of privateComment


ReturnFromVoid: Void methods should not have a @return tag.

Suggested change

* @return GUID of privateComment

*

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-12-30T14:12:50Z

.../odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java

+        {
+            return false;
+        }
+        if (dateAddedToCollection != null ? ! dateAddedToCollection.equals(that.dateAddedToCollection) : that.dateAddedToCollection != null)


💬 7 similar findings have been found in this PR

UndefinedEquals: Date does not have well-defined equals behavior.

🔎 Expand here to view all instances of this finding

File Path Line Number

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/RelationshipProperties.java 186

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ClassificationProperties.java 182

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ReferenceableProperties.java 274

open-metadata-implementation/access-services/digital-service/digital-service-api/src/main/java/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java 198

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/RelationshipProperties.java 187

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ReferenceableProperties.java 273

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ClassificationProperties.java 183

Visit the Lift Web Console to find more details in your report.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-12-30T14:12:51Z

...a/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java

+        }
+        else
+        {
+            return new Date(dateAddedToCollection.getTime());


💬 14 similar findings have been found in this PR

JavaUtilDate: Date has a bad API that leads to bugs; prefer java.time.Instant or LocalDate.

🔎 Expand here to view all instances of this finding

File Path Line Number

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java 1522

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java 220

open-metadata-implementation/access-services/digital-service/digital-service-api/src/main/java/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java 198

open-metadata-implementation/access-services/digital-service/digital-service-api/src/main/java/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java 96

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java 942

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java 1584

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java 199

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java 248

open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java 97

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java 1398

Showing 10 of 14 findings. Visit the Lift Web Console to see all.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

sonatype-lift · 2022-12-30T14:12:53Z

.../odpi/openmetadata/accessservices/assetconsumer/outtopic/AssetConsumerOMRSTopicListener.java

-        }
-
-        return false;
+        return repositoryHelper.isTypeOf(serviceName, entityHeader.getType().getTypeDefName(), OpenMetadataAPIMapper.ASSET_TYPE_NAME);


💬 4 similar findings have been found in this PR

NULL_DEREFERENCE: object returned by entityHeader.getType() could be null and is dereferenced at line 796.

🔎 Expand here to view all instances of this finding

File Path Line Number

open-metadata-implementation/access-services/stewardship-action/stewardship-action-server/src/main/java/org/odpi/openmetadata/accessservices/stewardshipaction/outtopic/StewardshipActionOMRSTopicListener.java 833

open-metadata-implementation/access-services/asset-owner/asset-owner-server/src/main/java/org/odpi/openmetadata/accessservices/assetowner/outtopic/AssetOwnerOMRSTopicListener.java 796

open-metadata-implementation/access-services/digital-architecture/digital-architecture-server/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/outtopic/DigitalArchitectureOMRSTopicListener.java 835

open-metadata-implementation/access-services/it-infrastructure/it-infrastructure-server/src/main/java/org/odpi/openmetadata/accessservices/itinfrastructure/listener/ITInfrastructureOMRSTopicListener.java 832

Visit the Lift Web Console to find more details in your report.

ℹ️ Learn about @sonatype-lift commands

You can reply with the following commands. For example, reply with @sonatype-lift ignoreall to leave out all findings.

Command Usage

@sonatype-lift ignore Leave out the above finding from this PR

@sonatype-lift ignoreall Leave out all the existing findings from this PR

@sonatype-lift exclude <file|issue|path|tool> Exclude specified file|issue|path|tool from Lift findings by updating your config.toml file

Note: When talking to LiftBot, you need to refresh the page to see its response.
_{Click here to add LiftBot to another repo.}

Was this a good recommendation?
[ 🙁 Not relevant ] - [ 😕 Won't fix ] - [ 😑 Not critical, will fix ] - [ 🙂 Critical, will fix ] - [ 😊 Critical, fixing now ]

mandy-chessell added 8 commits December 30, 2022 11:47

Create framework services

33ea5f0

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

New tests and fixes for Asset Consumer OMAS

6e37eb5

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Fixes to search interfaces

9bc2086

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Add collection interface to OMASs

03a3d0c

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Update documentation

30ddc1f

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Add final

ab993e7

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Update types for Data Mesh (6526)

4093e75

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Merge branch 'main' of https://github.com/odpi/egeria into egeria-code

35d1f16

mandy-chessell requested a review from dwolfson December 30, 2022 12:08

mandy-chessell requested a review from planetf1 as a code owner December 30, 2022 12:08

mandy-chessell removed the request for review from planetf1 December 30, 2022 12:08

mandy-chessell added 3 commits December 30, 2022 12:13

Correct name spelling (odpi#7244)

7775e5a

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Support framework-services in gradle build

f6c6069

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

Correct documentation URL (odpi#6551)

7d8abff

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>

mandy-chessell requested a review from davidradl as a code owner December 30, 2022 12:26

mandy-chessell removed the request for review from davidradl December 30, 2022 12:38

dwolfson approved these changes Dec 30, 2022

View reviewed changes

mandy-chessell merged commit 6011a47 into odpi:main Dec 30, 2022

sonatype-lift bot reviewed Dec 30, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Create framework services #7261

Create framework services #7261

mandy-chessell commented Dec 30, 2022

dwolfson left a comment

sonatype-lift bot Dec 30, 2022

sonatype-lift bot Dec 30, 2022

sonatype-lift bot Dec 30, 2022

sonatype-lift bot Dec 30, 2022

Command	Usage
`@sonatype-lift ignore`	Leave out the above finding from this PR
`@sonatype-lift ignoreall`	Leave out all the existing findings from this PR
`@sonatype-lift exclude <file\|issue\|path\|tool>`	Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file

File Path	Line Number
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/RelationshipProperties.java	186
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ClassificationProperties.java	182
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ReferenceableProperties.java	274
open-metadata-implementation/access-services/digital-service/digital-service-api/src/main/java/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java	198
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/RelationshipProperties.java	187
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ReferenceableProperties.java	273
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/properties/ClassificationProperties.java	183

File Path	Line Number
open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java	1522
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java	220
open-metadata-implementation/access-services/digital-service/digital-service-api/src/main/java/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java	198
open-metadata-implementation/access-services/digital-service/digital-service-api/src/main/java/org/odpi/openmetadata/accessservices/digitalservice/metadataelements/CollectionMember.java	96
open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java	942
open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java	1584
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java	199
open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java	248
open-metadata-implementation/access-services/digital-architecture/digital-architecture-api/src/main/java/org/odpi/openmetadata/accessservices/digitalarchitecture/metadataelements/CollectionMember.java	97
open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/server/AssetConsumerRESTServices.java	1398

Create framework services #7261

Create framework services #7261

Conversation

mandy-chessell commented Dec 30, 2022

Description

Related Issue(s)

Testing

Release Notes & Documentation

Additional notes

dwolfson left a comment

Choose a reason for hiding this comment

sonatype-lift bot Dec 30, 2022

Choose a reason for hiding this comment

sonatype-lift bot Dec 30, 2022

Choose a reason for hiding this comment

sonatype-lift bot Dec 30, 2022

Choose a reason for hiding this comment

sonatype-lift bot Dec 30, 2022

Choose a reason for hiding this comment