Package org.odpi.openmetadata.adapters.connectors.usageinsight.popularity

Class LovelacePopularityProfilerService

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.usageinsight.popularity.LovelacePopularityProfilerService

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, GovernanceActionService

public class LovelacePopularityProfilerService
extends GeneralGovernanceActionService

LovelacePopularityProfilerService maintains the MemberPopularityProfile classification of each root collection, glossary, data sharing hub, collection folder and digital product catalog. The profile totals the usage activity of the collection's members (linked through CollectionMembership): each member contributes the counts in its own UsageActivity classification, plus the totals of its own members if it is a collection too.

Nested collections of these kinds are profiled before the collection that contains them, within the same run, so the activity of the leaf members ripples up through every level to the top-level collections. A member that is a different kind of collection contributes the totals of its stored MemberPopularityProfile, if it has one.

The service is run by the Babbage Analytical Engine on each of its refreshes. Its reads of the members are made as part of building each collection's profile (they set viewElementGUID), so they are not counted as the members being found. A profile whose counts have not changed is not rewritten.

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

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

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
LovelacePopularityProfilerService()

Method Summary

Modifier and Type	Method	Description
void	start()	Profile every collection of the supported kinds.

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

LovelacePopularityProfilerService

public LovelacePopularityProfilerService()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Profile every collection of the supported kinds. This is a standard method from the Open Connector Framework (OCF), so be sure to call super.start() in your version.

Overrides:

start in class GeneralGovernanceActionService

Throws:

ConnectorCheckedException - a problem within the governance action service.

UserNotAuthorizedException - the service was disconnected before/during start