Improve the content of connector types (odpi#7103)

Signed-off-by: Mandy Chessell <mandy.e.chessell@gmail.com>
mandy-chessell · Nov 15, 2022 · b5d4a71 · b5d4a71
1 parent 2e304c1
commit b5d4a71
Show file tree

Hide file tree

Showing 121 changed files with 1,296 additions and 830 deletions.
diff --git a/...in/java/org/odpi/openmetadata/accessservices/assetmanager/rest/ConnectorTypeResponse.java b/...in/java/org/odpi/openmetadata/accessservices/assetmanager/rest/ConnectorTypeResponse.java
@@ -15,7 +15,7 @@
 import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY;
 
 /**
- * ConnectorTypeResponse is a response object for passing back a single connector type object.
+ * ConnectorReportResponse is a response object for passing back a single connector type object.
  */
 @JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
     @Override
     public String toString()
     {
-        return "ConnectorTypeResponse{" +
+        return "ConnectorReportResponse{" +
                 "element=" + element +
                 ", exceptionClassName='" + getExceptionClassName() + '\'' +
                 ", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +

diff --git a/...org/odpi/openmetadata/accessservices/assetmanager/client/rest/AssetManagerRESTClient.java b/...org/odpi/openmetadata/accessservices/assetmanager/client/rest/AssetManagerRESTClient.java
@@ -549,14 +549,14 @@ public ConnectionsResponse callConnectionsPostRESTCall(String    methodName,
 
 
     /**
-     * Issue a POST REST call that returns a ConnectorTypeResponse object.
+     * Issue a POST REST call that returns a ConnectorReportResponse object.
      *
      * @param methodName  name of the method being called.
      * @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
      * @param requestBody properties describing the valid value definition/set
      * @param params      a list of parameters that are slotted into the url template.
      *
-     * @return ConnectorTypeResponse
+     * @return ConnectorReportResponse
      * @throws InvalidParameterException one of the parameters is invalid.
      * @throws UserNotAuthorizedException the user is not authorized to make this request.
      * @throws PropertyServerException the repository is not available or not working properly.

diff --git a/...main/java/org/odpi/openmetadata/accessservices/assetowner/rest/ConnectorTypeResponse.java b/...main/java/org/odpi/openmetadata/accessservices/assetowner/rest/ConnectorTypeResponse.java
@@ -15,7 +15,7 @@
 import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY;
 
 /**
- * ConnectorTypeResponse is a response object for passing back a single connector type object.
+ * ConnectorReportResponse is a response object for passing back a single connector type object.
  */
 @JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
     @Override
     public String toString()
     {
-        return "ConnectorTypeResponse{" +
+        return "ConnectorReportResponse{" +
                 "element=" + element +
                 ", exceptionClassName='" + getExceptionClassName() + '\'' +
                 ", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +

diff --git a/...ava/org/odpi/openmetadata/accessservices/assetowner/client/rest/AssetOwnerRESTClient.java b/...ava/org/odpi/openmetadata/accessservices/assetowner/client/rest/AssetOwnerRESTClient.java
@@ -171,13 +171,13 @@ public ConnectionsResponse callConnectionsPostRESTCall(String    methodName,
 
 
     /**
-     * Issue a GET REST call that returns a ConnectorTypeResponse object.
+     * Issue a GET REST call that returns a ConnectorReportResponse object.
      *
      * @param methodName  name of the method being called.
      * @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
      * @param params      a list of parameters that are slotted into the url template.
      *
-     * @return ConnectorTypeResponse
+     * @return ConnectorReportResponse
      * @throws InvalidParameterException one of the parameters is invalid.
      * @throws UserNotAuthorizedException the user is not authorized to make this request.
      * @throws PropertyServerException the repository is not available or not working properly.

diff --git a/...ain/java/org/odpi/openmetadata/accessservices/datamanager/rest/ConnectorTypeResponse.java b/...ain/java/org/odpi/openmetadata/accessservices/datamanager/rest/ConnectorTypeResponse.java
@@ -15,7 +15,7 @@
 import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY;
 
 /**
- * ConnectorTypeResponse is a response object for passing back a single connector type object.
+ * ConnectorReportResponse is a response object for passing back a single connector type object.
  */
 @JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
     @Override
     public String toString()
     {
-        return "ConnectorTypeResponse{" +
+        return "ConnectorReportResponse{" +
                 "element=" + element +
                 ", exceptionClassName='" + getExceptionClassName() + '\'' +
                 ", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +

diff --git a/...a/org/odpi/openmetadata/accessservices/datamanager/client/rest/DataManagerRESTClient.java b/...a/org/odpi/openmetadata/accessservices/datamanager/client/rest/DataManagerRESTClient.java
@@ -171,13 +171,13 @@ public ConnectionsResponse callMyConnectionsPostRESTCall(String    methodName,
 
 
     /**
-     * Issue a GET REST call that returns a ConnectorTypeResponse object.
+     * Issue a GET REST call that returns a ConnectorReportResponse object.
      *
      * @param methodName  name of the method being called.
      * @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
      * @param params      a list of parameters that are slotted into the url template.
      *
-     * @return ConnectorTypeResponse
+     * @return ConnectorReportResponse
      * @throws InvalidParameterException one of the parameters is invalid.
      * @throws UserNotAuthorizedException the user is not authorized to make this request.
      * @throws PropertyServerException the repository is not available or not working properly.

diff --git a/...src/main/java/org/odpi/openmetadata/accessservices/devops/rest/ConnectorTypeResponse.java b/...src/main/java/org/odpi/openmetadata/accessservices/devops/rest/ConnectorTypeResponse.java
@@ -15,7 +15,7 @@
 import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY;
 
 /**
- * ConnectorTypeResponse is a response object for passing back a single connector type object.
+ * ConnectorReportResponse is a response object for passing back a single connector type object.
  */
 @JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
     @Override
     public String toString()
     {
-        return "ConnectorTypeResponse{" +
+        return "ConnectorReportResponse{" +
                 "element=" + element +
                 ", exceptionClassName='" + getExceptionClassName() + '\'' +
                 ", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +

diff --git a/.../org/odpi/openmetadata/accessservices/digitalarchitecture/rest/ConnectorTypeResponse.java b/.../org/odpi/openmetadata/accessservices/digitalarchitecture/rest/ConnectorTypeResponse.java
@@ -15,7 +15,7 @@
 import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY;
 
 /**
- * ConnectorTypeResponse is a response object for passing back a single connector type object.
+ * ConnectorReportResponse is a response object for passing back a single connector type object.
  */
 @JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
     @Override
     public String toString()
     {
-        return "ConnectorTypeResponse{" +
+        return "ConnectorReportResponse{" +
                 "element=" + element +
                 ", exceptionClassName='" + getExceptionClassName() + '\'' +
                 ", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +

diff --git a/...etadata/accessservices/digitalarchitecture/client/rest/DigitalArchitectureRESTClient.java b/...etadata/accessservices/digitalarchitecture/client/rest/DigitalArchitectureRESTClient.java
@@ -225,13 +225,13 @@ public ConnectionsResponse callConnectionsPostRESTCall(String    methodName,
 
 
     /**
-     * Issue a GET REST call that returns a ConnectorTypeResponse object.
+     * Issue a GET REST call that returns a ConnectorReportResponse object.
      *
      * @param methodName  name of the method being called.
      * @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
      * @param params      a list of parameters that are slotted into the url template.
      *
-     * @return ConnectorTypeResponse
+     * @return ConnectorReportResponse
      * @throws InvalidParameterException one of the parameters is invalid.
      * @throws UserNotAuthorizedException the user is not authorized to make this request.
      * @throws PropertyServerException the repository is not available or not working properly.

diff --git a/...ava/org/odpi/openmetadata/accessservices/itinfrastructure/rest/ConnectorTypeResponse.java b/...ava/org/odpi/openmetadata/accessservices/itinfrastructure/rest/ConnectorTypeResponse.java
@@ -15,7 +15,7 @@
 import static com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility.PUBLIC_ONLY;
 
 /**
- * ConnectorTypeResponse is a response object for passing back a single connector type object.
+ * ConnectorReportResponse is a response object for passing back a single connector type object.
  */
 @JsonAutoDetect(getterVisibility=PUBLIC_ONLY, setterVisibility=PUBLIC_ONLY, fieldVisibility=NONE)
 @JsonInclude(JsonInclude.Include.NON_NULL)
@@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
     @Override
     public String toString()
     {
-        return "ConnectorTypeResponse{" +
+        return "ConnectorReportResponse{" +
                 "element=" + element +
                 ", exceptionClassName='" + getExceptionClassName() + '\'' +
                 ", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +

diff --git a/.../openmetadata/accessservices/itinfrastructure/client/rest/ITInfrastructureRESTClient.java b/.../openmetadata/accessservices/itinfrastructure/client/rest/ITInfrastructureRESTClient.java
@@ -173,13 +173,13 @@ public ConnectionsResponse callConnectionsPostRESTCall(String    methodName,
 
 
     /**
-     * Issue a GET REST call that returns a ConnectorTypeResponse object.
+     * Issue a GET REST call that returns a ConnectorReportResponse object.
      *
      * @param methodName  name of the method being called.
      * @param urlTemplate template of the URL for the REST API call with place-holders for the parameters.
      * @param params      a list of parameters that are slotted into the url template.
      *
-     * @return ConnectorTypeResponse
+     * @return ConnectorReportResponse
      * @throws InvalidParameterException one of the parameters is invalid.
      * @throws UserNotAuthorizedException the user is not authorized to make this request.
      * @throws PropertyServerException the repository is not available or not working properly.

diff --git a/...ava/org/odpi/openmetadata/adapters/connectors/dynamicarchivers/DynamicArchiveService.java b/...ava/org/odpi/openmetadata/adapters/connectors/dynamicarchivers/DynamicArchiveService.java
@@ -3,7 +3,7 @@
 package org.odpi.openmetadata.adapters.connectors.dynamicarchivers;
 
 import org.odpi.openmetadata.engineservices.repositorygovernance.connector.RepositoryGovernanceContext;
-import org.odpi.openmetadata.engineservices.repositorygovernance.connector.RepositoryGovernanceService;
+import org.odpi.openmetadata.engineservices.repositorygovernance.connector.RepositoryGovernanceServiceConnector;
 import org.odpi.openmetadata.engineservices.repositorygovernance.ffdc.RepositoryGovernanceErrorCode;
 import org.odpi.openmetadata.frameworks.connectors.Connector;
 import org.odpi.openmetadata.frameworks.connectors.ffdc.ConnectorCheckedException;
@@ -36,7 +36,7 @@
  * of a specific open metadata archive.  Information about the available metadata is passed in the archive context.
  * The returned archive context also contains the status of this service.
  */
-public abstract class DynamicArchiveService extends RepositoryGovernanceService
+public abstract class DynamicArchiveService extends RepositoryGovernanceServiceConnector
 {
     /*
      * This is the header information for the archive.

diff --git a/...pters/connectors/governanceactions/provisioning/MoveCopyFileGovernanceActionProvider.java b/...pters/connectors/governanceactions/provisioning/MoveCopyFileGovernanceActionProvider.java
@@ -17,7 +17,7 @@
 public class MoveCopyFileGovernanceActionProvider extends GovernanceActionServiceProviderBase
 {
     private static final String  connectorTypeGUID = "e2a14ca8-57b1-48d7-9cc4-d0b44983ca79";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Provisioning:MoveCopyFile";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Provisioning:MoveCopyFile";
     private static final String  connectorTypeDisplayName = "Move or Copy File Governance Action Service";
     private static final String  connectorTypeDescription = "Provisioning Governance Action Service that moves or copies files on request.";
 

diff --git a/...apters/connectors/governanceactions/remediation/OriginSeekerGovernanceActionProvider.java b/...apters/connectors/governanceactions/remediation/OriginSeekerGovernanceActionProvider.java
@@ -15,7 +15,7 @@
 public class OriginSeekerGovernanceActionProvider extends GovernanceActionServiceProviderBase
 {
     private static final String  connectorTypeGUID = "1c6939c4-de2c-44aa-a044-0ec64df0560f";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Remediation:OriginSeeker";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Remediation:OriginSeeker";
     private static final String  connectorTypeDisplayName = "Origin Seeker Governance Action Service";
     private static final String  connectorTypeDescription = "Follows the lineage mapping for an action target element to determine its origin.";
 

diff --git a/...ors/governanceactions/remediation/QualifiedNamePeerDuplicateGovernanceActionProvider.java b/...ors/governanceactions/remediation/QualifiedNamePeerDuplicateGovernanceActionProvider.java
@@ -15,7 +15,7 @@
 public class QualifiedNamePeerDuplicateGovernanceActionProvider extends GovernanceActionServiceProviderBase
 {
     private static final String  connectorTypeGUID = "346939c4-de2c-44aa-a044-0ec64df0560f";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Remediation:Deduplication";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Remediation:Deduplication";
     private static final String  connectorTypeDisplayName = "Deduplication Governance Action Service";
     private static final String  connectorTypeDescription = "Checks the qualified name of an action target element to determine its duplicates.";
 

diff --git a/...pters/connectors/governanceactions/remediation/ZonePublisherGovernanceActionProvider.java b/...pters/connectors/governanceactions/remediation/ZonePublisherGovernanceActionProvider.java
@@ -16,7 +16,7 @@
 public class ZonePublisherGovernanceActionProvider extends GovernanceActionServiceProviderBase
 {
     private static final String  connectorTypeGUID = "add1ff1b-d32d-42e7-9ebf-a2d26276aafe";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Remediation:ZonePublisher";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Remediation:ZonePublisher";
     private static final String  connectorTypeDisplayName = "Zone Publisher Governance Action Service";
     private static final String  connectorTypeDescription = "Assigns the configured zone(s) to the requested asset.";
 

diff --git a/...apters/connectors/governanceactions/verification/VerifyAssetGovernanceActionProvider.java b/...apters/connectors/governanceactions/verification/VerifyAssetGovernanceActionProvider.java
@@ -18,7 +18,7 @@
 public class VerifyAssetGovernanceActionProvider extends GovernanceActionServiceProviderBase
 {
     private static final String  connectorTypeGUID = "26df5406-8c4b-4738-96f6-1aea5dfd71de";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Verification:VerifyAsset";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Verification:VerifyAsset";
     private static final String  connectorTypeDisplayName = "Move or Copy File Governance Action Service";
     private static final String  connectorTypeDescription = "Provisioning Governance Action Service that moves or copies files on request.";
 

diff --git a/...s/connectors/governanceactions/verification/VerifyFileFolderGovernanceActionProvider.java b/...s/connectors/governanceactions/verification/VerifyFileFolderGovernanceActionProvider.java
@@ -17,7 +17,7 @@
 public class VerifyFileFolderGovernanceActionProvider extends GovernanceActionServiceProviderBase
 {
     private static final String  connectorTypeGUID = "1fc4f300-5003-4b1e-8669-953ade4a3742";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Verification:VerifyFileFolder";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Verification:VerifyFileFolder";
     private static final String  connectorTypeDisplayName = "Verify File Folder Governance Action Service";
     private static final String  connectorTypeDescription = "Verification Governance Action Service that checks whether a file asset is located in a particular folder.";
 

diff --git a/...connectors/governanceactions/watchdog/GenericElementWatchdogGovernanceActionProvider.java b/...connectors/governanceactions/watchdog/GenericElementWatchdogGovernanceActionProvider.java
@@ -19,7 +19,7 @@
 public class GenericElementWatchdogGovernanceActionProvider extends GenericWatchdogGovernanceActionProvider
 {
     private static final String  connectorTypeGUID = "8145967e-bb83-44b2-bc8c-68112c6a5a06";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Watchdog:GenericElement";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Watchdog:GenericElement";
     private static final String  connectorTypeDisplayName = "Generic Element Watchdog Governance Action Service";
     private static final String  connectorTypeDescription =
             "A Watchdog Governance Action Service that detects changes to requested elements and initiates a governance action process when they " +

diff --git a/.../connectors/governanceactions/watchdog/GenericFolderWatchdogGovernanceActionProvider.java b/.../connectors/governanceactions/watchdog/GenericFolderWatchdogGovernanceActionProvider.java
@@ -16,7 +16,7 @@
 public class GenericFolderWatchdogGovernanceActionProvider extends GenericWatchdogGovernanceActionProvider
 {
     private static final String  connectorTypeGUID = "b4629f05-710c-492b-bc9c-6e3f89e002df";
-    private static final String  connectorTypeQualifiedName = "Egeria:GovernanceActionService:Watchdog:GenericFolder";
+    private static final String  connectorTypeQualifiedName = "Egeria:GeneralGovernanceActionService:Watchdog:GenericFolder";
     private static final String  connectorTypeDisplayName = "Generic Folder Watchdog Governance Action Service";
     private static final String  connectorTypeDescription = "Watchdog Governance Action Service that listens for events relating to file assets located in a particular folder.";
 

diff --git a/...odpi/openmetadata/adminservices/configuration/registration/CommonServicesDescription.java b/...odpi/openmetadata/adminservices/configuration/registration/CommonServicesDescription.java
@@ -9,7 +9,7 @@
 import java.util.List;
 
 /**
- * AccessServiceDescription provides a list of registered OMAS services.
+ * CommonServicesDescription provides a list of fixed services that support the platform.
  */
 public enum CommonServicesDescription implements Serializable
 {

diff --git a/...ain/java/org/odpi/openmetadata/adminservices/configuration/registration/package-info.java b/...ain/java/org/odpi/openmetadata/adminservices/configuration/registration/package-info.java
@@ -5,4 +5,4 @@
  * The registration package provides the definitions and interfaces to describe each of the Open Metadata
  * and Governance services that support the different subsystems within the OMAG Server.
  */
-package org.odpi.openmetadata.adminservices.configuration.api;
+package org.odpi.openmetadata.adminservices.configuration.registration;
diff --git a/...s/src/main/java/org/odpi/openmetadata/commonservices/ffdc/properties/ConnectorReport.java b/...s/src/main/java/org/odpi/openmetadata/commonservices/ffdc/properties/ConnectorReport.java
@@ -6,7 +6,6 @@
 import com.fasterxml.jackson.annotation.JsonAutoDetect;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonInclude;
-import org.odpi.openmetadata.commonservices.ffdc.rest.ConnectorTypeResponse;
 import org.odpi.openmetadata.frameworks.auditlog.ComponentDescription;
 import org.odpi.openmetadata.frameworks.connectors.properties.beans.ConnectorType;
 
@@ -71,23 +70,6 @@ public ConnectorReport(ConnectorReport template)
     }
 
 
-    /**
-     * Copy/clone constructor
-     *
-     * @param template object to copy
-     */
-    public ConnectorReport(ConnectorTypeResponse template)
-    {
-        if (template != null)
-        {
-            this.componentDescription     = template.getComponentDescription();
-            this.connectorType            = template.getConnectorType();
-            this.refreshTimeInterval      = template.getRefreshTimeInterval();
-            this.usesBlockingCalls        = template.getUsesBlockingCalls();
-        }
-    }
-
-
     /**
      * Return the component description information that the connector uses to register with the audit log.
      *
@@ -159,7 +141,7 @@ public void setRefreshTimeInterval(long refreshTimeInterval)
 
 
     /**
-     * Return if the connector should be started in its own thread to allow it is block on a listening call.
+     * Return if the connector should be started in its own thread to allow it to block on a listening call.
      *
      * @return boolean flag
      */
@@ -170,7 +152,7 @@ public boolean getUsesBlockingCalls()
 
 
     /**
-     * Set up if the connector should be started in its own thread to allow it is block on a listening call.
+     * Set up if the connector should be started in its own thread to allow it to block on a listening call.
      *
      * @param usesBlockingCalls boolean flag
      */