Merge branch 'main' into git7140

content-packs/CocoClinicalTrialsTemplatesArchive.json

@@ -1 +1 @@
-{"class":"OpenMetadataArchive","archiveProperties":{"class":"OpenMetadataArchiveProperties","archiveGUID":"74a786b2-d6d7-401d-b8c1-7d798f752c55","archiveName":"Coco Pharmaceuticals Clinical Trials Templates","archiveDescription":"Templates for new assets relating to a clinical trial.","archiveType":"CONTENT_PACK","originatorName":"Egeria Project","originatorLicense":"Apache 2.0","creationDate":1668588486684,"dependsOnArchives":["bce3b0a0-662a-4f87-b8dc-844078a11a6e"]}}
+{"class":"OpenMetadataArchive","archiveProperties":{"class":"OpenMetadataArchiveProperties","archiveGUID":"74a786b2-d6d7-401d-b8c1-7d798f752c55","archiveName":"Coco Pharmaceuticals Clinical Trials Templates","archiveDescription":"Templates for new assets relating to a clinical trial.","archiveType":"CONTENT_PACK","originatorName":"Egeria Project","originatorLicense":"Apache 2.0","creationDate":1669229449553,"dependsOnArchives":["bce3b0a0-662a-4f87-b8dc-844078a11a6e"]}}

content-packs/README.md

@@ -23,11 +23,19 @@ They supply metadata to support the Coco Pharmaceuticals scenarios.
   them and the load of their data into the data lake.  This archive simulates the type of metadata expected from
   an ETL tool suite.  It is intended for **cocoMDS5** in the open metadata labs but can be used in any server.
 
+* **Coco Pharmaceuticals Organizations** - provides the profiles, user identifies and team of the featured
+  personas of Coco Pharmaceuticals.
+
 * **CocoClinicalTrialsTemplatesArchive** - provides the template assets used for onboarding weekly patient measurements during a clinical trial.
 
+* **Governance Program Definitions** - provides the metadata to describe Coco Pharmaceuticals governance program.
+
 * **CocoGovernanceEngineDefinitionsArchive** - provides the metadata to describe Coco Pharmaceuticals three governance engines:
   `AssetGovernance`, `AssetDiscovery` and `AssetQuality`.
 
+* **Coco Pharmaceuticals Sustainability Initiative** provides the base definitions for Coco Pharmaceutical's
+  sustainability initiative.
+
 * **CocoTypesArchive** - provides additional types for Coco Pharmaceuticals.  These are `BiopsyScope` Enum, `BiopsyReport` Entity, `BiopsySupportingEvidence` Relationship and
   `ReviewedByClinicalTrials` Classification.
 

open-metadata-implementation/access-services/asset-consumer/asset-consumer-api/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/api/package-info.java

@@ -2,7 +2,8 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * The API package defines the Java interfaces supported by the Asset Consumer OMAS.  These Java interfaces
- * wrap the REST API calls to the server and the asynchronous event passing through Asset Consumer's Out Topic
+ * The API package defines the Java interfaces supported by the Asset Consumer OMAS.
+ *
+ * These Java interfaces wrap the REST API calls to the server and the asynchronous event passing through Asset Consumer OMAS's Out Topic.
  */
 package org.odpi.openmetadata.accessservices.assetconsumer.api;

open-metadata-implementation/access-services/asset-consumer/asset-consumer-client/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/client/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * These are the Java clients for the Asset Consumer OMAS.
+ */
+package org.odpi.openmetadata.accessservices.assetconsumer.client;

open-metadata-implementation/access-services/asset-consumer/asset-consumer-client/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/client/rest/package-info.java

@@ -3,8 +3,9 @@
 
 /**
  * This package provides the support for issuing REST API calls to the OMAG Server and processing common error responses
- * (InvalidParameterException, UserNotAuthorizedException, PropertyServerException)
- * from the calls.  This leaves the Asset Consumer OMAS Clients to focus on marshalling requests and returning successful responses.
+ * (InvalidParameterException, UserNotAuthorizedException, PropertyServerException) from the calls.
+ *
+ * This leaves the Asset Consumer OMAS Clients to focus on marshalling requests and returning successful responses.
  */
 
 package org.odpi.openmetadata.accessservices.assetconsumer.client.rest;

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/admin/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * Provides the implementation of the admin classes that are called during server start up and shut down.
+ */
+package org.odpi.openmetadata.accessservices.assetconsumer.admin;

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/converters/package-info.java

@@ -0,0 +1,8 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * Provides the converters that take beans from the repository services (eg entities and relationships)
+ * and converts them into Asset Consumer OMAS beans to return to the caller.
+ */
+package org.odpi.openmetadata.accessservices.assetconsumer.converters;

open-metadata-implementation/access-services/asset-consumer/asset-consumer-server/src/main/java/org/odpi/openmetadata/accessservices/assetconsumer/outtopic/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * The implementation of the outbound events from the Asset Consumer OMAS.
+ */
+package org.odpi.openmetadata.accessservices.assetconsumer.outtopic;

open-metadata-implementation/access-services/asset-manager/asset-manager-api/src/main/java/org/odpi/openmetadata/accessservices/assetmanager/api/package-info.java

@@ -2,8 +2,9 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * This package contains the different interfaces of the asset manager.  Each interface is
- * focused on the exchange of groups of related metadata elements between a third party
+ * This package contains the different interfaces of the asset manager.
+ *
+ * Each interface is focused on the exchange of groups of related metadata elements between a third party
  * asset manager and open metadata.
  *
  * <ul>

open-metadata-implementation/access-services/asset-manager/asset-manager-client/src/main/java/org/odpi/openmetadata/accessservices/assetmanager/client/package-info.java

@@ -2,31 +2,6 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * These are the client interfaces of the Asset Manager OMAS.
- *
- * <ul>
- *     <li>ExternalAssetManagerClient enables the caller to create the Software Server Capability that represents
- *         the source, or owner, of the metadata.  These sources are typically metadata catalogs that
- *         are not sophisticated enough to join an open metadata cohort through the OMRS Repository Connector.</li>
- *
- *     <li>AssetManagerEventClient enables the client to send and receive events from the Asset Manager OMAS.</li>
- *
- *     <li>CollaborationExchangeClient enables the caller to describe comments, likes, ratings and tags.</li>
- *
- *     <li>DataAssetExchangeClient enables the caller to describe data assets, schemas and connections.</li>
- *
- *     <li>GlossaryExchangeClient enables the caller to describe glossaries, glossary categories, glossary terms
- *         and the relationships between them.</li>
- *
- *     <li>GovernanceExchangeClient enables the caller to describe governance policies and rules.</li>
- *
- *     <li>InfrastructureExchangeClient enables the caller to describe servers and related infrastructure.</li>
- *
- *     <li>LineageExchangeClient support for creating lineage from processing engines.</li>
- *
- *     <li>StewardshipExchangeClient enables the caller to describe classifications and issues found in assets.</li>
- *
- *     <li>ValidValuesExchangeClient enables the caller to describe reference data.</li>
- * </ul>
+ * These are the Java clients for the Asset Manager OMAS.
  */
 package org.odpi.openmetadata.accessservices.assetmanager.client;

open-metadata-implementation/access-services/asset-manager/asset-manager-client/src/main/java/org/odpi/openmetadata/accessservices/assetmanager/client/rest/package-info.java

@@ -2,6 +2,10 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * This package contains the internal class for issuing REST calls.
+ * This package provides the support for issuing REST API calls to the OMAG Server and processing common error responses
+ * (InvalidParameterException, UserNotAuthorizedException, PropertyServerException) from the calls.
+ *
+ * This leaves the Asset Manager OMAS Clients to focus on marshalling requests and returning successful responses.
  */
+
 package org.odpi.openmetadata.accessservices.assetmanager.client.rest;

open-metadata-implementation/access-services/asset-owner/asset-owner-api/src/main/java/org/odpi/openmetadata/accessservices/assetowner/api/package-info.java

@@ -2,6 +2,8 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * This package provides the definition of the Java API for the Asset Owner OMAS.
+ * The API package defines the Java interfaces supported by the Asset Owner OMAS.
+ *
+ * These Java interfaces wrap the REST API calls to the server and the asynchronous event passing through Asset Owner OMAS's Out Topic.
  */
 package org.odpi.openmetadata.accessservices.assetowner.api;

open-metadata-implementation/access-services/asset-owner/asset-owner-api/src/main/java/org/odpi/openmetadata/accessservices/assetowner/events/package-info.java

@@ -1,7 +1,6 @@
 /* SPDX-License-Identifier: Apache 2.0 */
 /* Copyright Contributors to the ODPi Egeria project. */
-
 /**
- * This package contains stub headers for events when Asset Owner OMAS supported events.
+ * Definitions of the different types of events that the Asset Owner OMAS can publish.
  */
-package org.odpi.openmetadata.accessservices.assetowner.events;
+package org.odpi.openmetadata.accessservices.assetowner.events;

open-metadata-implementation/access-services/asset-owner/asset-owner-api/src/main/java/org/odpi/openmetadata/accessservices/assetowner/metadataelements/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * The metadata elements describe the way that metadata is returned from the repository.
+ */
+package org.odpi.openmetadata.accessservices.assetowner.metadataelements;

open-metadata-implementation/access-services/asset-owner/asset-owner-api/src/main/java/org/odpi/openmetadata/accessservices/assetowner/properties/package-info.java

@@ -2,7 +2,8 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * This properties package provides the properties used to create different types of instances for an asset and its attachments.
+ * This package provides the properties used to create different types of instances for an asset and its attachments.
+ *
  * They are used as request body structures on the REST APIs and are also embedded in the element beans when the instances are
  * retrieved from the repository
  */

open-metadata-implementation/access-services/asset-owner/asset-owner-client/src/main/java/org/odpi/openmetadata/accessservices/assetowner/client/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * These are the Java clients for the Asset Owner OMAS.
+ */
+package org.odpi.openmetadata.accessservices.assetowner.client;

open-metadata-implementation/access-services/asset-owner/asset-owner-client/src/main/java/org/odpi/openmetadata/accessservices/assetowner/client/rest/package-info.java

@@ -0,0 +1,11 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * This package provides the support for issuing REST API calls to the OMAG Server and processing common error responses
+ * (InvalidParameterException, UserNotAuthorizedException, PropertyServerException) from the calls.
+ *
+ * This leaves the Asset Owner OMAS Clients to focus on marshalling requests and returning successful responses.
+ */
+
+package org.odpi.openmetadata.accessservices.assetowner.client.rest;

open-metadata-implementation/access-services/asset-owner/asset-owner-server/src/main/java/org/odpi/openmetadata/accessservices/assetowner/admin/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * Provides the implementation of the admin classes that are called during server start up and shut down.
+ */
+package org.odpi.openmetadata.accessservices.assetowner.admin;

open-metadata-implementation/access-services/asset-owner/asset-owner-server/src/main/java/org/odpi/openmetadata/accessservices/assetowner/converters/package-info.java

@@ -0,0 +1,8 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * Provides the converters that take beans from the repository services (eg entities and relationships)
+ * and converts them into Asset Owner OMAS beans to return to the caller.
+ */
+package org.odpi.openmetadata.accessservices.assetowner.converters;

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

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * The implementation of the outbound events from the Asset Owner OMAS.
+ */
+package org.odpi.openmetadata.accessservices.assetowner.outtopic;

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

@@ -1098,15 +1098,15 @@ public GUIDListResponse  getFolderFiles(String  serverName,
                     FolderElement,
                     FileElement> handler = instanceHandler.getFilesAndFoldersHandler(userId, serverName, methodName);
 
-            response.setGUIDs(handler.getFolderFiles(userId,
-                                                     folderGUID,
-                                                     folderGUIDParameterName,
-                                                     startingFrom,
-                                                     maxPageSize,
-                                                     false,
-                                                     false,
-                                                     new Date(),
-                                                     methodName));
+            response.setGUIDs(handler.getFolderFileGUIDs(userId,
+                                                         folderGUID,
+                                                         folderGUIDParameterName,
+                                                         startingFrom,
+                                                         maxPageSize,
+                                                         false,
+                                                         false,
+                                                         new Date(),
+                                                         methodName));
         }
         catch (Exception error)
         {

open-metadata-implementation/access-services/asset-owner/asset-owner-spring/src/main/java/org/odpi/openmetadata/accessservices/assetowner/server/spring/FileSystemOnboardingResource.java

@@ -450,7 +450,7 @@ public FolderResponse getFolderByPathName(@PathVariable String                se
      * @param startingFrom starting point in the list
      * @param maxPageSize maximum number of results
      *
-     * @return list of folder unique identifiers (null means no nested folders) or
+     * @return list of folder unique identifiers (null value means no nested folders) or
      * InvalidParameterException one of the parameters is null or invalid or
      * PropertyServerException problem accessing property server or
      * UserNotAuthorizedException security access problem.

open-metadata-implementation/access-services/community-profile/community-profile-api/src/main/java/org/odpi/openmetadata/accessservices/communityprofile/api/package-info.java

@@ -2,9 +2,10 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * The Community Profile Open Metadata Access Service (OMAS) is used by tools and administrators to
- * maintain information associated with individuals and communities. The client interfaces are each targeted
- * at different use cases.
+ * The API package defines the Java interfaces supported by the Community Profile OMAS.
+ *
+ * The Community Profile OMAS is used by tools and administrators to maintain information associated with individuals and communities.
+ * The client interfaces are each targeted at different use cases.
  *
  * Not all client interfaces are implemented.  The interface that begin "MyXXX" are expected to move to a new View service called My Profile OMVS.
  */

open-metadata-implementation/access-services/community-profile/community-profile-api/src/main/java/org/odpi/openmetadata/accessservices/communityprofile/metadataelements/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * The metadata elements describe the way that metadata is returned from the repository.
+ */
+package org.odpi.openmetadata.accessservices.communityprofile.metadataelements;

open-metadata-implementation/access-services/community-profile/community-profile-api/src/main/java/org/odpi/openmetadata/accessservices/communityprofile/properties/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * These beans describe the core properties that are passed to the server to create and update metadata.
+ */
+package org.odpi.openmetadata.accessservices.communityprofile.properties;

open-metadata-implementation/access-services/community-profile/community-profile-client/src/main/java/org/odpi/openmetadata/accessservices/communityprofile/client/rest/package-info.java

@@ -0,0 +1,11 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * This package provides the support for issuing REST API calls to the OMAG Server and processing common error responses
+ * (InvalidParameterException, UserNotAuthorizedException, PropertyServerException) from the calls.
+ *
+ * This leaves the Data Manager OMAS Clients to focus on marshalling requests and returning successful responses.
+ */
+
+package org.odpi.openmetadata.accessservices.communityprofile.client.rest;

open-metadata-implementation/access-services/community-profile/community-profile-server/src/main/java/org/odpi/openmetadata/accessservices/communityprofile/admin/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * Provides the implementation of the admin classes that are called during server start up and shut down.
+ */
+package org.odpi.openmetadata.accessservices.communityprofile.admin;

open-metadata-implementation/access-services/data-manager/data-manager-api/src/main/java/org/odpi/openmetadata/accessservices/datamanager/api/SchemaManagerInterface.java

@@ -17,7 +17,7 @@
  * EventBrokerInterface, ApplicationInterface and the APIManagerInterface.
  *
  * SchemaAttributes describe the data fields of the schema. If a schema attribute's type is simple (that is
- * primitive, literal, enum or external, its details are passed with the schema attribute.  Complex schema types (such as Maps,
+ * primitive, literal, enum or external) its details are passed with the schema attribute.  Complex schema types (such as Maps,
  * Choices) are constructed first and then their identifiers are attached to the schema attribute.
  * SchemaTypes are used when creating complex schema structures that involve maps, choice and links to externally defined
  * schemas that are, for example, part of a standard.

open-metadata-implementation/access-services/data-manager/data-manager-api/src/main/java/org/odpi/openmetadata/accessservices/datamanager/api/package-info.java

@@ -0,0 +1,9 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * The API package defines the Java interfaces supported by the Data Manager OMAS.
+ *
+ * These Java interfaces wrap the REST API calls to the server and the asynchronous event passing through Data Manager OMAS's Out Topic.
+ */
+package org.odpi.openmetadata.accessservices.datamanager.api;

open-metadata-implementation/access-services/data-manager/data-manager-api/src/main/java/org/odpi/openmetadata/accessservices/datamanager/metadataelements/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * The metadata elements describe the way that metadata is returned from the repository.
+ */
+package org.odpi.openmetadata.accessservices.datamanager.metadataelements;

open-metadata-implementation/access-services/data-manager/data-manager-api/src/main/java/org/odpi/openmetadata/accessservices/datamanager/properties/ReferenceableProperties.java

@@ -58,7 +58,7 @@ public ReferenceableProperties()
 
 
     /**
-     * Copy/clone constructor.  Retrieves values from the supplied template
+     * Copy/clone constructor.  Retrieves the values from the supplied template
      *
      * @param template element to copy
      */

open-metadata-implementation/access-services/data-manager/data-manager-api/src/main/java/org/odpi/openmetadata/accessservices/datamanager/properties/package-info.java

@@ -0,0 +1,7 @@
+/* SPDX-License-Identifier: Apache 2.0 */
+/* Copyright Contributors to the ODPi Egeria project. */
+
+/**
+ * These beans describe the core properties that are passed to the server to create and update metadata.
+ */
+package org.odpi.openmetadata.accessservices.datamanager.properties;

open-metadata-implementation/access-services/data-manager/data-manager-api/src/main/java/org/odpi/openmetadata/accessservices/datamanager/rest/package-info.java

@@ -1,14 +1,6 @@
 /* SPDX-License-Identifier: Apache 2.0 */
 /* Copyright Contributors to the ODPi Egeria project. */
 
-/**
- * This package defines the beans used to build the REST request and response payloads.
- *
- * REST APIs can pass parameters in their URLs (called path variables) as well has having a RequestBody bean
- * for additional, more complex, or optional parameters.  Responses are returned in response beans.
- *
- * The response beans encode the return type of the method as well as any exceptions and associated messages.
- */
 /**
  * This package defines the beans used to build the REST request and response payloads.
  *

open-metadata-implementation/access-services/data-manager/data-manager-client/src/main/java/org/odpi/openmetadata/accessservices/datamanager/client/package-info.java

@@ -2,7 +2,7 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * These are the client interfaces of the Data Manager OMAS.
+ * These are the Java clients for the Data Manager OMAS.
  *
  * <ul>
  *     <li>MetadataSourceClient enables the caller to create the Software Server Capability that represents

open-metadata-implementation/access-services/data-manager/data-manager-client/src/main/java/org/odpi/openmetadata/accessservices/datamanager/client/rest/package-info.java

@@ -2,6 +2,10 @@
 /* Copyright Contributors to the ODPi Egeria project. */
 
 /**
- * This package contains the internal class for issuing REST calls.
+ * This package provides the support for issuing REST API calls to the OMAG Server and processing common error responses
+ * (InvalidParameterException, UserNotAuthorizedException, PropertyServerException) from the calls.
+ *
+ * This leaves the Asset Manager OMAS Clients to focus on marshalling requests and returning successful responses.
  */
+
 package org.odpi.openmetadata.accessservices.datamanager.client.rest;