Package org.odpi.openmetadata.adapters.connectors.unitycatalog.survey

Class OSSUnityCatalogServerSurveyBase

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.surveyaction.SurveyActionServiceConnector

org.odpi.openmetadata.adapters.connectors.unitycatalog.survey.OSSUnityCatalogServerSurveyBase

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, SurveyActionService

Direct Known Subclasses:

OSSUnityCatalogInsideCatalogSurveyService, OSSUnityCatalogInsideSchemaSurveyService, OSSUnityCatalogServerSurveyService

public class OSSUnityCatalogServerSurveyBase
extends SurveyActionServiceConnector

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	OSSUnityCatalogServerSurveyBase.ResourceProperties	Information about a UC resource collected for the inventory.

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

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
protected String	finalAnalysisStep	This is the point after which the processing stops.

Fields inherited from class org.odpi.openmetadata.frameworks.surveyaction.SurveyActionServiceConnector

auditLog, connector, embeddedConnectors, objectMapper, propertyHelper, surveyActionServiceName, surveyContext

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
OSSUnityCatalogServerSurveyBase()

Method Summary

Modifier and Type	Method	Description
protected String	getCatalogName()	Return the name of the catalog to survey; or throw an exception if there is no catalog name.
protected ResourceProfileAnnotation	getNameListAnnotation(UnityCatalogAnnotationType annotationType, Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> nameProperties)	Fill out a name list annotation.
protected String	getSchemaName()	Return the name of the schema to survey; or throw an exception if there is no schema name.
protected void	setFinalAnalysisStep()	Retrieve any configured final analysis step
protected void	writeInventory(String inventoryName, Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> catalogList, Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> schemaList, Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> functionList, Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> tableList, Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> volumeList)	Add an inventory annotation to the survey report.

Methods inherited from class org.odpi.openmetadata.frameworks.surveyaction.SurveyActionServiceConnector

disconnect, getAnnotationStore, getConnectorComponentDescription, getEmbeddedSurveyActionServices, getJSONProperties, getNestedSchemaType, getSurveyContext, handleUnexpectedException, initializeEmbeddedConnectors, performCheckAssetAnalysisStep, performCheckAssetAnalysisStep, setAuditLog, setSurveyActionServiceName, setSurveyContext, setUpAnnotation, start, throwMissingSchemaType, writeNameCountInventory, writeNameDescriptionInventory, writeNameListInventory, writePropertyListInventory

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

disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getIntConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, throwMissingConfigurationProperty, throwMissingResource, throwNoAsset, throwWrongTypeOfAsset, throwWrongTypeOfResource, throwWrongTypeOfRootSchema, toString

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

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

Methods inherited from class java.lang.Object

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

Field Details

finalAnalysisStep

protected String finalAnalysisStep

This is the point after which the processing stops. The default is PRODUCE_INVENTORY - which is the last analysis step. It can be changed through configuration properties or request parameters passed when this survey action service is called.

Constructor Details

OSSUnityCatalogServerSurveyBase

public OSSUnityCatalogServerSurveyBase()

Method Details

setFinalAnalysisStep

protected void setFinalAnalysisStep()
                             throws ConnectorCheckedException

Retrieve any configured final analysis step

Throws:

ConnectorCheckedException - problem with context

getNameListAnnotation

protected ResourceProfileAnnotation getNameListAnnotation(UnityCatalogAnnotationType annotationType,
 Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> nameProperties)

Fill out a name list annotation.

Parameters:

annotationType - type of annotation

nameProperties - list of names with properties

Returns:

annotation

getCatalogName

protected String getCatalogName()
                         throws ConnectorCheckedException

Return the name of the catalog to survey; or throw an exception if there is no catalog name.

Returns:

name of the catalog to survey

Throws:

ConnectorCheckedException - the catalog name is not specified

getSchemaName

protected String getSchemaName()
                        throws ConnectorCheckedException

Return the name of the schema to survey; or throw an exception if there is no schema name.

Returns:

name of the catalog to survey

Throws:

ConnectorCheckedException - the catalog name is not specified

writeInventory

protected void writeInventory(String inventoryName,
 Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> catalogList,
 Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> schemaList,
 Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> functionList,
 Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> tableList,
 Map<String,OSSUnityCatalogServerSurveyBase.ResourceProperties> volumeList)
                       throws ConnectorCheckedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
IOException

Add an inventory annotation to the survey report.

Parameters:

inventoryName - name of the inventory

catalogList - list of catalog names and descriptions

schemaList - list of schema names and descriptions

functionList - list of function names and descriptions

tableList - list of table names and descriptions

volumeList - list of volume names and descriptions

Throws:

IOException - problem writing file

InvalidParameterException - problem creating CSV file asset

PropertyServerException - repository problem creating CSV file asset

UserNotAuthorizedException - authorization problem creating CSV file asset

ConnectorCheckedException - survey has been asked to stop