Package org.odpi.openmetadata.adapters.connectors.apachekafka.resource

Class ApacheKafkaAdminConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.apachekafka.resource.ApacheKafkaAdminConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

public class ApacheKafkaAdminConnector
extends ConnectorBase
implements AuditLoggingComponent

ApacheKafkaAdminConnector provides access to an Apache Kafka's Admin API.

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.connectors.ConnectorBase

connectionBean, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
ApacheKafkaAdminConnector()	Default Constructor used by the connector provider.

Method Summary

Modifier and Type	Method	Description
org.apache.kafka.clients.admin.DescribeTopicsResult	describeTopics()	Return details about each topic
void	disconnect()	Free up any resources held since the connector is no longer needed.
ComponentDescription	getConnectorComponentDescription()	Return the component description that is used by this connector in the audit log.
Set<String>	getTopicList()	Return the list of topics defined to the Apache Kafka server.
Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric>	metrics()	Return the metrics available from the Apache Kafka Server.
void	setAuditLog(AuditLog auditLog)	Receive an audit log object that can be used to record audit log messages.
void	start()	Indicates that the connector is completely configured and can begin processing.

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

combineConfigurationProperties, disconnectConnectors, equals, fromCanonicalToKebabCase, fromCanonicalToSnakeCase, fromKebabToCanonicalCase, fromSnakeToCanonicalCase, getArrayConfigurationProperty, getArrayConfigurationProperty, getArrayConfigurationProperty, getBooleanConfigurationProperty, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getStringConfigurationProperty, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, throwMissingConfigurationProperty, 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

ApacheKafkaAdminConnector

public ApacheKafkaAdminConnector()

Default Constructor used by the connector provider.

Method Details

setAuditLog

public void setAuditLog(AuditLog auditLog)

Receive an audit log object that can be used to record audit log messages. The caller has initialized it with the correct component description and log destinations.

Specified by:

setAuditLog in interface AuditLoggingComponent

Parameters:

auditLog - audit log object

getConnectorComponentDescription

public ComponentDescription getConnectorComponentDescription()

Return the component description that is used by this connector in the audit log.

Specified by:

getConnectorComponentDescription in interface AuditLoggingComponent

Returns:

id, name, description, wiki page URL.

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.

Overrides:

start in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

UserNotAuthorizedException - the connector was disconnected before/during start

getTopicList

public Set<String> getTopicList()
                         throws ConnectorCheckedException

Return the list of topics defined to the Apache Kafka server.

Returns:

set of topic names

Throws:

ConnectorCheckedException - unexpected exception

metrics

public Map<org.apache.kafka.common.MetricName,? extends org.apache.kafka.common.Metric> metrics()

Return the metrics available from the Apache Kafka Server.

Returns:

map of metric definitions to metric values

describeTopics

public org.apache.kafka.clients.admin.DescribeTopicsResult describeTopics()
                                                                   throws ConnectorCheckedException

Return details about each topic

Returns:

topic details

Throws:

ConnectorCheckedException - problem accessing event broker

disconnect

public void disconnect()
                throws ConnectorCheckedException

Free up any resources held since the connector is no longer needed.

Overrides:

disconnect in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.