OpenMetadataArchiveStoreConnector (Repository Services General APIs 3.5 API)

java.lang.Object
- org.odpi.openmetadata.frameworks.connectors.Connector
- - org.odpi.openmetadata.frameworks.connectors.ConnectorBase
  - - org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

All Implemented Interfaces:

AuditLoggingComponent, OpenMetadataArchiveStore
```
public abstract class OpenMetadataArchiveStoreConnector
extends ConnectorBase
implements OpenMetadataArchiveStore, AuditLoggingComponent
```
OpenMetadataArchiveStoreConnector is the base class for connectors that support the OpenMetadataArchiveStore

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, securedProperties

Constructor Summary

Constructors
Constructor Description

OpenMetadataArchiveStoreConnector()

Method Summary

All Methods Instance Methods Concrete Methods
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
disconnect, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initialize, initializeConnectedAssetProperties, isActive, start, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStore
getArchiveContents, setArchiveContents

- Field Detail
  - auditLog
```
protected AuditLog auditLog
```
- Constructor Detail
  - OpenMetadataArchiveStoreConnector
```
public OpenMetadataArchiveStoreConnector()
```
- Method Detail
  - 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.