Package org.odpi.openmetadata.adapters.connectors.restclients

Class RESTClientConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.adapters.connectors.restclients.RESTClientConnector

All Implemented Interfaces:

RESTClientCalls, AuditLoggingComponent, SecureConnectorExtension, VirtualConnectorExtension

Direct Known Subclasses:

SpringRESTClientConnector

public abstract class RESTClientConnector
extends ConnectorBase
implements RESTClientCalls, SecureConnectorExtension, AuditLoggingComponent

RESTClientConnector provides the base class for REST Client connectors.

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
protected AuditLog	auditLog

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, embeddedConnectors, messageFormatter, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
RESTClientConnector()	Default constructor

Method Summary

Modifier and Type	Method	Description
ComponentDescription	getConnectorComponentDescription()	Return the component description that is used by this connector in the audit log.
void	setAuditLog(AuditLog auditLog)	Receive an audit log object that can be used to record audit log messages.

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

combineConfigurationProperties, disconnect, disconnectConnectors, equals, getArrayConfigurationProperty, getAssetTypeName, getBooleanConfigurationProperty, getConnectedAssetProperties, getConnection, getConnectorInstanceId, getDateConfigurationProperty, getIntConfigurationProperty, getLongConfigurationProperty, getNetworkAddresses, getStringConfigurationProperty, getSuppliedPlaceholderProperties, hashCode, initialize, initializeConnectedAssetProperties, initializeEmbeddedConnectors, initializeSecretsStoreConnector, isActive, logExceptionRecord, logRecord, logRecord, start, 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

Methods inherited from interface org.odpi.openmetadata.adapters.connectors.restclients.RESTClientCalls

callDeleteRESTCall, callDeleteRESTCallNoParams, callGetRESTCall, callGetRESTCallNoParams, callPatchRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCallNoParams

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

initializeSecretsStoreConnector

Field Details

auditLog

protected AuditLog auditLog

Constructor Details

RESTClientConnector

public RESTClientConnector()

Default constructor

Method Details

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.

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