org.odpi.egeria.connectors.juxt.crux.repositoryconnector

Class CruxOMRSRepositoryConnectorProvider

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.ConnectorProvider

org.odpi.openmetadata.frameworks.connectors.ConnectorProviderBase

org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryConnectorProviderBase

org.odpi.egeria.connectors.juxt.crux.repositoryconnector.CruxOMRSRepositoryConnectorProvider

All Implemented Interfaces:

org.odpi.openmetadata.frameworks.auditlog.AuditLoggingComponent

public class CruxOMRSRepositoryConnectorProvider
extends org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryConnectorProviderBase

In the Open Connector Framework (OCF), a ConnectorProvider is a factory for a specific type of connector. The CruxOMRSRepositoryConnectorProvider is the connector provider for the CruxOMRSRepositoryConnector. It extends OMRSRepositoryConnectorProviderBase which in turn extends the OCF ConnectorProviderBase. ConnectorProviderBase supports the creation of connector instances.

The CruxOMRSRepositoryConnectorProvider must initialize ConnectorProviderBase with the Java class name of the OMRS Connector implementation (by calling super.setConnectorClassName(className)). Then the connector provider will work.

The configurationProperties can contain the following keys:

• cruxConfig: a Crux configuration document that follows the JSON structure documented on Crux's site: https://opencrux.com/reference/21.01-1.14.0/configuration.html
• syncIndex: a boolean indicating whether writes should be done synchronously (true, default) to ensure the index is up-to-date before returning, or asynchronously (false) to ensure that the transaction is recorded but that the index can be eventually consistent (faster writes)
• luceneRegexes: a boolean indicating whether any unquoted regexes (those not surrounded by \Q and \E) should be treated as Lucene regexes (true) or not (false). Technically the search interfaces are meant to take Java regexes; however, if usage of the connector is only expected to pass fairly simple regexes that are also supported by Lucene, enabling this should significantly improve the performance of queries against text data that involves regexes that are unquoted. (Regexes that are quoted will be handled appropriately irrespective of this setting.) Note that this will have no impact if Lucene itself is not configured.

For example: { "class": "Connection", "connectorType": { "class": "ConnectorType", "connectorProviderClassName": "org.odpi.egeria.connectors.juxt.crux.repositoryconnector.CruxOMRSRepositoryConnectorProvider" }, "configurationProperties": { "cruxConfig": { "crux/index-store": { "kv-store": { "crux/module": "crux.rocksdb/->kv-store", "db-dir": "data/servers/crux/rdb-index" } }, "crux/document-store": { "kv-store": { "crux/module": "crux.rocksdb/->kv-store", "db-dir": "data/servers/crux/rdb-docs" } }, "crux/tx-log": { "crux/module": "crux.kafka/->tx-log", "kafka-config": { "bootstrap-servers": "localhost:9092" }, "tx-topic-opts": { "topic-name": "crux-tx-log" }, "poll-wait-duration": "PT1S" } }, "syncIndex": false, "luceneRegexes": true } }

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRUX_CONFIG
static String	LUCENE_REGEXES
static String	SYNCHRONOUS_INDEX

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

auditLog, connectorTypeBean

Constructor Summary

Constructors

Constructor and Description
CruxOMRSRepositoryConnectorProvider() Constructor used to initialize the ConnectorProviderBase with the Java class name of the specific OMRS Connector implementation.

Method Summary

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

equals, getConnector, getConnector, getConnectorClassName, getConnectorType, getConnectorTypeProperties, getNewConnectorGUID, hashCode, setAuditLog, setConnectorClassName, setConnectorComponentDescription, setConnectorTypeProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

CRUX_CONFIG

public static final String CRUX_CONFIG

See Also:

Constant Field Values

SYNCHRONOUS_INDEX

public static final String SYNCHRONOUS_INDEX

See Also:

Constant Field Values

LUCENE_REGEXES

public static final String LUCENE_REGEXES

See Also:

Constant Field Values

Constructor Detail

CruxOMRSRepositoryConnectorProvider

public CruxOMRSRepositoryConnectorProvider()

Constructor used to initialize the ConnectorProviderBase with the Java class name of the specific OMRS Connector implementation.