Package org.odpi.openmetadata.adapters.connectors.governanceactions.remediation

Class AnchorsZoneResynchronizerGovernanceActionConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.opengovernance.GovernanceActionServiceConnector

org.odpi.openmetadata.frameworks.opengovernance.GeneralGovernanceActionService

org.odpi.openmetadata.adapters.connectors.governanceactions.remediation.AnchorsZoneResynchronizerGovernanceActionConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, GovernanceActionService

public class AnchorsZoneResynchronizerGovernanceActionConnector
extends GeneralGovernanceActionService

AnchorsZoneResynchronizerGovernanceActionConnector corrects the governance zones held in Anchors classifications. An Anchors classification records the zones that govern its element - the element's own if it has a ZoneMembership classification, otherwise its anchor's - so that searches can leave out the elements in zones the caller can not read. The metadata access server keeps them up to date as zones change, but they can be out of date in a repository populated before it did, and for elements loaded from an open metadata archive. Each correction is sent to the repository named in the classification header, so reference copies of elements from other members of the cohort are corrected through the member that owns them.

With action targets, each target is checked, along with the members of any target that is an anchor. Without them, every element in the repository is checked. The service completes with anchors-zones-corrected if it corrected any classification, and anchors-zones-up-to-date if there was nothing to correct. If any element could not be checked or corrected, the other targets are still checked and the service completes with anchors-zones-resync-failed. Running it until it reports anchors-zones-up-to-date shows that searches filtered by governance zone (on by default, controlled by the pushDownZoneFilter property of the Open Metadata Access Security Connector) return every element each user may read.

Nested Class Summary

Nested classes/interfaces inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

ConnectorBase.ProtectedConnection

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.opengovernance.GeneralGovernanceActionService

governanceContext

Fields inherited from class org.odpi.openmetadata.frameworks.opengovernance.GovernanceActionServiceConnector

governanceServiceName, propertyHelper

Fields inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
AnchorsZoneResynchronizerGovernanceActionConnector()

Method Summary

Modifier and Type	Method	Description
void	start()	Indicates that the governance action service is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.opengovernance.GeneralGovernanceActionService

disconnect, getActionTarget, getAllActionTargets, getProperty, setGovernanceContext

Methods inherited from class org.odpi.openmetadata.frameworks.opengovernance.GovernanceActionServiceConnector

getArrayRequestParameter, getBooleanRequestParameter, getConnectorComponentDescription, getIntRequestParameter, getLongRequestParameter, getStringRequestParameter, handleUnexpectedException, setAuditLog, setGovernanceServiceName, validateContext

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayValue, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, throwMissingElement, throwMissingEndpointAddress, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.Connector

clearStatisticProperty, clearStatisticTimestamp, getConnectorStatistics, getStatisticCounter, getStatisticProperty, getStatisticTimestamp, incrementStatisticCounter, initializeStatisticCounter, refreshStatistics, setStatisticProperty, setStatisticTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AnchorsZoneResynchronizerGovernanceActionConnector

public AnchorsZoneResynchronizerGovernanceActionConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the governance action service is completely configured and can begin processing. This is a standard method from the Open Connector Framework (OCF) so be sure to call super.start() at the start of your overriding version.

Overrides:

start in class GeneralGovernanceActionService

Throws:

ConnectorCheckedException - a problem within the governance action service.

UserNotAuthorizedException - the connector was disconnected before/during start