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
-
Nested Class Summary
Modifier and TypeClassDescriptionprotected static class
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
Modifier and TypeFieldDescriptionprotected String
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, messageFormatter, secretsStoreConnectorMap
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected String
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
Return the name of the schema to survey; or throw an exception if there is no schema name.protected void
Retrieve any configured final analysis stepprotected 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, performCheckAssetAnalysisStep, performCheckAssetAnalysisStep, setAuditLog, setSurveyActionServiceName, setSurveyContext, setUpAnnotation, start, throwMissingSchemaType, writeNameCountInventory, writeNameDescriptionInventory, writeNameListInventory, writePropertyListInventory
Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ConnectorBase
combineConfigurationProperties, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, 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
-
Field Details
-
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
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 annotationnameProperties
- list of names with properties- Returns:
- annotation
-
getCatalogName
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
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, throws ConnectorCheckedException, InvalidParameterException, PropertyServerException, UserNotAuthorizedException, IOExceptionOSSUnityCatalogServerSurveyBase.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.- Parameters:
inventoryName
- name of the inventorycatalogList
- list of catalog names and descriptionsschemaList
- list of schema names and descriptionsfunctionList
- list of function names and descriptionstableList
- list of table names and descriptionsvolumeList
- list of volume names and descriptions- Throws:
IOException
- problem writing fileInvalidParameterException
- problem creating CSV file assetPropertyServerException
- repository problem creating CSV file assetUserNotAuthorizedException
- authorization problem creating CSV file assetConnectorCheckedException
- survey has been asked to stop
-