Package org.odpi.openmetadata.adapters.connectors.integration.openapis

Class OpenAPIMonitorIntegrationConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

org.odpi.openmetadata.adapters.connectors.integration.openapis.OpenAPIMonitorIntegrationConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension, IntegrationConnector, OpenMetadataEventListener

public class OpenAPIMonitorIntegrationConnector
extends IntegrationConnectorBase
implements OpenMetadataEventListener

OpenAPIMonitorIntegrationConnector builds an open metadata representation of the open API specifications published by the servers it is monitoring. For each API specification it catalogues a DeployedAPI asset linked to the server's Endpoint, an APISchemaType describing the API, an APIOperation for each path/command combination, and the request, response and header structures for each operation, built out of APIParameterList and APIParameter schema elements. See ... for more information on schema types and schema attributes.

Nested Class Summary

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

ConnectorBase.ProtectedConnection

Field Summary

Fields

Modifier and Type	Field	Description
static final com.fasterxml.jackson.databind.ObjectReader	OBJECT_READER

Fields inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

catalogTargetsManager, connectorName, integrationContext, propertyHelper

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

auditLog, connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
OpenAPIMonitorIntegrationConnector()

Method Summary

Modifier and Type	Method	Description
void	disconnect()	Shutdown monitoring
void	processEvent(OpenMetadataOutTopicEvent event)	Process an event that was published by the Data Manager OMAS.
void	refresh()	Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.connectors.IntegrationConnectorBase

engage, getConnectorComponentDescription, getNetworkAddress, passEventToCatalogTargets, refreshCatalogTargets, setAuditLog, setConnectorName, setContext

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

combineConfigurationProperties, disconnectConnectors, equals, fromCamelToCanonicalCase, fromCanonicalToCamelCase, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getSecretsCollectionName, getSecretsLocation, getSecretsProvider, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, 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

Methods inherited from interface org.odpi.openmetadata.frameworks.connectors.VirtualConnectorExtension

initializeEmbeddedConnectors

Field Details

OBJECT_READER

public static final com.fasterxml.jackson.databind.ObjectReader OBJECT_READER

Constructor Details

OpenAPIMonitorIntegrationConnector

public OpenAPIMonitorIntegrationConnector()

Method Details

start

public void start()
           throws ConnectorCheckedException,
UserNotAuthorizedException

Indicates that the connector is completely configured and can begin processing. This call can be used to register with non-blocking services.

Specified by:

start in interface IntegrationConnector

Overrides:

start in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - the connector detected a problem.

UserNotAuthorizedException - the connector was disconnected before/during start

processEvent

public void processEvent(OpenMetadataOutTopicEvent event)

Process an event that was published by the Data Manager OMAS.

Specified by:

processEvent in interface OpenMetadataEventListener

Parameters:

event - event object - call getEventType to find out what type of event.

refresh

public void refresh()

Requests that the connector does a comparison of the metadata in the third party technology and open metadata repositories. Refresh is called when the integration connector first starts and then at intervals defined in the connector's configuration as well as any external REST API calls to explicitly refresh the connector.

Specified by:

refresh in interface IntegrationConnector

disconnect

public void disconnect()
                throws ConnectorCheckedException

Shutdown monitoring

Specified by:

disconnect in interface IntegrationConnector

Overrides:

disconnect in class IntegrationConnectorBase

Throws:

ConnectorCheckedException - something failed in the super class