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.

Sign up for GitHub

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

Jump to bottom

Improve the content of connector types (#7103) #7106

Merged
merged 2 commits into from
Nov 15, 2022
Merged

Improve the content of connector types (#7103) #7106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b5d4a71
Improve the content of connector types (#7103)
mandy-chessell Nov 15, 2022
5f878af
Merge branch 'main' of https://github.com/odpi/egeria into egeria-code
mandy-chessell Nov 15, 2022
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
4 changes: 2 additions & 2 deletions ...in/java/org/odpi/openmetadata/accessservices/assetmanager/rest/ConnectorTypeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
@Override
public String toString()
{
return "ConnectorTypeResponse{" +
return "ConnectorReportResponse{" +
"element=" + element +
", exceptionClassName='" + getExceptionClassName() + '\'' +
", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +
Expand Down
4 changes: 2 additions & 2 deletions ...org/odpi/openmetadata/accessservices/assetmanager/client/rest/AssetManagerRESTClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions ...main/java/org/odpi/openmetadata/accessservices/assetowner/rest/ConnectorTypeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
@Override
public String toString()
{
return "ConnectorTypeResponse{" +
return "ConnectorReportResponse{" +
"element=" + element +
", exceptionClassName='" + getExceptionClassName() + '\'' +
", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +
Expand Down
4 changes: 2 additions & 2 deletions ...ava/org/odpi/openmetadata/accessservices/assetowner/client/rest/AssetOwnerRESTClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions ...ain/java/org/odpi/openmetadata/accessservices/datamanager/rest/ConnectorTypeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
@Override
public String toString()
{
return "ConnectorTypeResponse{" +
return "ConnectorReportResponse{" +
"element=" + element +
", exceptionClassName='" + getExceptionClassName() + '\'' +
", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +
Expand Down
4 changes: 2 additions & 2 deletions ...a/org/odpi/openmetadata/accessservices/datamanager/client/rest/DataManagerRESTClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions ...src/main/java/org/odpi/openmetadata/accessservices/devops/rest/ConnectorTypeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
@Override
public String toString()
{
return "ConnectorTypeResponse{" +
return "ConnectorReportResponse{" +
"element=" + element +
", exceptionClassName='" + getExceptionClassName() + '\'' +
", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +
Expand Down
4 changes: 2 additions & 2 deletions .../org/odpi/openmetadata/accessservices/digitalarchitecture/rest/ConnectorTypeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
@Override
public String toString()
{
return "ConnectorTypeResponse{" +
return "ConnectorReportResponse{" +
"element=" + element +
", exceptionClassName='" + getExceptionClassName() + '\'' +
", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +
Expand Down
4 changes: 2 additions & 2 deletions ...etadata/accessservices/digitalarchitecture/client/rest/DigitalArchitectureRESTClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions ...ava/org/odpi/openmetadata/accessservices/itinfrastructure/rest/ConnectorTypeResponse.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -81,7 +81,7 @@ public void setElement(ConnectorTypeElement element)
@Override
public String toString()
{
return "ConnectorTypeResponse{" +
return "ConnectorReportResponse{" +
"element=" + element +
", exceptionClassName='" + getExceptionClassName() + '\'' +
", exceptionCausedBy='" + getExceptionCausedBy() + '\'' +
Expand Down
4 changes: 2 additions & 2 deletions .../openmetadata/accessservices/itinfrastructure/client/rest/ITInfrastructureRESTClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions ...ava/org/odpi/openmetadata/adapters/connectors/dynamicarchivers/DynamicArchiveService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion ...pters/connectors/governanceactions/provisioning/MoveCopyFileGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...apters/connectors/governanceactions/remediation/OriginSeekerGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...ors/governanceactions/remediation/QualifiedNamePeerDuplicateGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...pters/connectors/governanceactions/remediation/ZonePublisherGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...apters/connectors/governanceactions/verification/VerifyAssetGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...s/connectors/governanceactions/verification/VerifyFileFolderGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...connectors/governanceactions/watchdog/GenericElementWatchdogGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 " +
Expand Down
2 changes: 1 addition & 1 deletion .../connectors/governanceactions/watchdog/GenericFolderWatchdogGovernanceActionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.";

Expand Down
2 changes: 1 addition & 1 deletion ...odpi/openmetadata/adminservices/configuration/registration/CommonServicesDescription.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
{
Expand Down
2 changes: 1 addition & 1 deletion ...ain/java/org/odpi/openmetadata/adminservices/configuration/registration/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
22 changes: 2 additions & 20 deletions ...s/src/main/java/org/odpi/openmetadata/commonservices/ffdc/properties/ConnectorReport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;

Expand Down Expand Up @@ -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.
*
Expand Down Expand Up @@ -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
*/
Expand All @@ -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
*/
Expand Down
Loading