Package org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.directory

Class DirectoryBasedOpenMetadataArchiveStoreConnector

java.lang.Object

org.odpi.openmetadata.frameworks.connectors.Connector

org.odpi.openmetadata.frameworks.connectors.ConnectorBase

org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

org.odpi.openmetadata.adapters.repositoryservices.archiveconnector.directory.DirectoryBasedOpenMetadataArchiveStoreConnector

All Implemented Interfaces:

AuditLoggingComponent, SecureConnectorExtension, OpenMetadataArchiveBuilder, OpenMetadataArchiveStore

public class DirectoryBasedOpenMetadataArchiveStoreConnector
extends OpenMetadataArchiveStoreConnector
implements OpenMetadataArchiveBuilder

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.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

auditLog

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

connectedAssetProperties, connectionBean, connectionProperties, connectorInstanceId, secretsStoreConnectorMap

Constructor Summary

Constructors

Constructor	Description
DirectoryBasedOpenMetadataArchiveStoreConnector()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addClassification(ClassificationEntityExtension classification)	Add a new classification to the archive.
void	addClassificationDef(ClassificationDef classificationDef)	Add a new ClassificationDef to the archive.
void	addCollectionDef(CollectionDef collectionDef)	Add a new CollectionDef to the archive.
void	addEntity(EntityDetail entity)	Add a new entity to the archive.
void	addEntityDef(EntityDef entityDef)	Add a new EntityDef to the archive.
void	addEnumDef(EnumDef enumDef)	Add a new EnumDef to the archive.
void	addPrimitiveDef(PrimitiveDef primitiveDef)	Add a new PrimitiveDef to the archive.
void	addRelationship(Relationship relationship)	Add a new relationship to the archive.
void	addRelationshipDef(RelationshipDef relationshipDef)	Add a new RelationshipDef to the archive.
void	addTypeDefPatch(TypeDefPatch typeDefPatch)	Add a new patch to the archive.
void	disconnect()	Free up any resources held since the connector is no longer needed.
OpenMetadataArchive	getArchiveContents()	Return the contents of the archive.
OpenMetadataArchiveProperties	getArchiveProperties()	Return the archive properties.
ClassificationEntityExtension	getClassification(String entityGUID, String classificationName)	Retrieve a classification extension from the archive.
ClassificationDef	getClassificationDef(String classificationDefName)	Retrieve the relationshipDef or null if it is not defined.
CollectionDef	getCollectionDef(String collectionDefName)	Retrieve a CollectionDef from the archive.
EntityDetail	getEntity(String guid)	Retrieve an entity from the archive.
EntityDef	getEntityDef(String entityDefName)	Retrieve the entityDef or null if it is not defined.
EnumDef	getEnumDef(String enumDefName)	Get an existing EnumDef from the archive.
TypeDefPatch	getPatchForType(String typeName)	Create a skeleton patch for a TypeDefPatch.
PrimitiveDef	getPrimitiveDef(String primitiveDefName)	Retrieve a PrimitiveDef from the archive.
Relationship	getRelationship(String guid)	Retrieve a relationship from the archive.
RelationshipDef	getRelationshipDef(String relationshipDefName)	Retrieve the relationshipDef or null if it is not defined.
TypeDef	getTypeDefByName(String typeName)	Return the requested type definition if known.
void	initialize(String connectorInstanceId, ConnectionProperties connectionProperties)	Retrieve the archive store information from the endpoint.
ClassificationEntityExtension	queryClassification(String entityGUID, String classificationName)	Retrieve a classification extension from the archive.
EntityDetail	queryEntity(String guid)	Retrieve an entity from the archive.
Relationship	queryRelationship(String guid)	Retrieve a relationship from the archive.
void	setArchiveContents(OpenMetadataArchive archiveContents)	Set new contents into the archive.
void	setArchiveProperties(String archiveGUID, String archiveName, String archiveDescription, OpenMetadataArchiveType archiveType, String archiveVersion, String originatorName, String originatorLicense, Date creationDate, List<OpenMetadataArchive> dependsOnArchives)	Set up archive header and initialize the maps assuming it is building a new archive.
void	start()	Indicates that the connector is completely configured and can begin processing.

Methods inherited from class org.odpi.openmetadata.repositoryservices.connectors.stores.archivestore.OpenMetadataArchiveStoreConnector

getConnectorComponentDescription, setAuditLog

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

disconnectConnectors, equals, getConnectedAssetProperties, getConnection, getConnectorInstanceId, hashCode, initializeConnectedAssetProperties, initializeSecretsStoreConnector, isActive, 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

Constructor Details

DirectoryBasedOpenMetadataArchiveStoreConnector

public DirectoryBasedOpenMetadataArchiveStoreConnector()

Default constructor

Method Details

initialize

public void initialize(String connectorInstanceId,
 ConnectionProperties connectionProperties)

Retrieve the archive store information from the endpoint.

Overrides:

initialize in class ConnectorBase

Parameters:

connectorInstanceId - unique id for the connector instance useful for messages etc

connectionProperties - POJO for the configuration used to create the connector.

start

public void start()
           throws ConnectorCheckedException

Indicates that the connector is completely configured and can begin processing.

Overrides:

start in class ConnectorBase

Throws:

ConnectorCheckedException - there is a problem within the connector.

getArchiveContents

public OpenMetadataArchive getArchiveContents()

Return the contents of the archive.

Specified by:

getArchiveContents in interface OpenMetadataArchiveStore

Returns:

OpenMetadataArchive object

getArchiveProperties

public OpenMetadataArchiveProperties getArchiveProperties()

Return the archive properties.

Specified by:

getArchiveProperties in interface OpenMetadataArchiveBuilder

Returns:

properties structure stored as a file encoded in JSON

setArchiveContents

public void setArchiveContents(OpenMetadataArchive archiveContents)

Set new contents into the archive. This overrides any content previously stored.

Specified by:

setArchiveContents in interface OpenMetadataArchiveStore

Parameters:

archiveContents - OpenMetadataArchive object

setArchiveProperties

public void setArchiveProperties(String archiveGUID,
 String archiveName,
 String archiveDescription,
 OpenMetadataArchiveType archiveType,
 String archiveVersion,
 String originatorName,
 String originatorLicense,
 Date creationDate,
 List<OpenMetadataArchive> dependsOnArchives)

Set up archive header and initialize the maps assuming it is building a new archive. It passes parameters used to build the open metadata archive's property header including the default license string. This determines the license and copyright for all instances in the archive that do not have their own explicit license string. The default license string will be inserted into each instance with a null license when it is loaded into an open metadata repository.

Specified by:

setArchiveProperties in interface OpenMetadataArchiveBuilder

Parameters:

archiveGUID - unique identifier for this open metadata archive.

archiveName - name of the open metadata archive.

archiveDescription - description of the open metadata archive.

archiveType - enum describing the type of archive this is.

archiveVersion - descriptive name for the version of the archive.

originatorName - name of the originator (person or organization) of the archive.

originatorLicense - default license string for content.

creationDate - data that this archive was created.

dependsOnArchives - list of archives that this archive depends on (null for no dependencies).

addPrimitiveDef

public void addPrimitiveDef(PrimitiveDef primitiveDef)

Add a new PrimitiveDef to the archive.

Specified by:

addPrimitiveDef in interface OpenMetadataArchiveBuilder

Parameters:

primitiveDef - type to add nulls are ignored

getPrimitiveDef

public PrimitiveDef getPrimitiveDef(String primitiveDefName)

Retrieve a PrimitiveDef from the archive.

Specified by:

getPrimitiveDef in interface OpenMetadataArchiveBuilder

Parameters:

primitiveDefName - primitive to retrieve

Returns:

PrimitiveDef type

addCollectionDef

public void addCollectionDef(CollectionDef collectionDef)

Add a new CollectionDef to the archive.

Specified by:

addCollectionDef in interface OpenMetadataArchiveBuilder

Parameters:

collectionDef - type to add

getCollectionDef

public CollectionDef getCollectionDef(String collectionDefName)

Retrieve a CollectionDef from the archive.

Specified by:

getCollectionDef in interface OpenMetadataArchiveBuilder

Parameters:

collectionDefName - type to retrieve

Returns:

CollectionDef type

addEnumDef

public void addEnumDef(EnumDef enumDef)

Add a new EnumDef to the archive.

Specified by:

addEnumDef in interface OpenMetadataArchiveBuilder

Parameters:

enumDef - type to add

getEnumDef

public EnumDef getEnumDef(String enumDefName)

Get an existing EnumDef from the archive.

Specified by:

getEnumDef in interface OpenMetadataArchiveBuilder

Parameters:

enumDefName - type to retrieve

Returns:

EnumDef object

addClassificationDef

public void addClassificationDef(ClassificationDef classificationDef)

Add a new ClassificationDef to the archive.

Specified by:

addClassificationDef in interface OpenMetadataArchiveBuilder

Parameters:

classificationDef - type to add

getClassificationDef

public ClassificationDef getClassificationDef(String classificationDefName)

Retrieve the relationshipDef or null if it is not defined.

Specified by:

getClassificationDef in interface OpenMetadataArchiveBuilder

Parameters:

classificationDefName - name of the classification

Returns:

the retrieved classification def

addEntityDef

public void addEntityDef(EntityDef entityDef)

Add a new EntityDef to the archive.

Specified by:

addEntityDef in interface OpenMetadataArchiveBuilder

Parameters:

entityDef - type to add

getEntityDef

public EntityDef getEntityDef(String entityDefName)

Retrieve the entityDef or null if it is not defined.

Specified by:

getEntityDef in interface OpenMetadataArchiveBuilder

Parameters:

entityDefName - name of the entity

Returns:

the retrieved entity def

getRelationshipDef

public RelationshipDef getRelationshipDef(String relationshipDefName)

Retrieve the relationshipDef or null if it is not defined.

Specified by:

getRelationshipDef in interface OpenMetadataArchiveBuilder

Parameters:

relationshipDefName - name of the relationship

Returns:

the retrieved relationship def

addRelationshipDef

public void addRelationshipDef(RelationshipDef relationshipDef)

Add a new RelationshipDef to the archive.

Specified by:

addRelationshipDef in interface OpenMetadataArchiveBuilder

Parameters:

relationshipDef - type to add

getPatchForType

public TypeDefPatch getPatchForType(String typeName)

Create a skeleton patch for a TypeDefPatch.

Specified by:

getPatchForType in interface OpenMetadataArchiveBuilder

Parameters:

typeName - name of type

Returns:

TypeDefPatch

addTypeDefPatch

public void addTypeDefPatch(TypeDefPatch typeDefPatch)

Add a new patch to the archive.

Specified by:

addTypeDefPatch in interface OpenMetadataArchiveBuilder

Parameters:

typeDefPatch - patch

getTypeDefByName

public TypeDef getTypeDefByName(String typeName)

Return the requested type definition if known.

Specified by:

getTypeDefByName in interface OpenMetadataArchiveBuilder

Parameters:

typeName - name ot type

Returns:

type definition

addEntity

public void addEntity(EntityDetail entity)

Add a new entity to the archive.

Specified by:

addEntity in interface OpenMetadataArchiveBuilder

Parameters:

entity - instance to add

getEntity

public EntityDetail getEntity(String guid)

Retrieve an entity from the archive.

Specified by:

getEntity in interface OpenMetadataArchiveBuilder

Parameters:

guid - unique identifier

Returns:

requested entity

queryEntity

public EntityDetail queryEntity(String guid)

Retrieve an entity from the archive.

Specified by:

queryEntity in interface OpenMetadataArchiveBuilder

Parameters:

guid - unique identifier

Returns:

requested entity

addRelationship

public void addRelationship(Relationship relationship)

Add a new relationship to the archive.

Specified by:

addRelationship in interface OpenMetadataArchiveBuilder

Parameters:

relationship - instance to add

getRelationship

public Relationship getRelationship(String guid)

Retrieve a relationship from the archive.

Specified by:

getRelationship in interface OpenMetadataArchiveBuilder

Parameters:

guid - unique identifier

Returns:

requested relationship

queryRelationship

public Relationship queryRelationship(String guid)

Retrieve a relationship from the archive.

Specified by:

queryRelationship in interface OpenMetadataArchiveBuilder

Parameters:

guid - unique identifier

Returns:

requested relationship

addClassification

public void addClassification(ClassificationEntityExtension classification)

Add a new classification to the archive.

Specified by:

addClassification in interface OpenMetadataArchiveBuilder

Parameters:

classification - instance to add

getClassification

public ClassificationEntityExtension getClassification(String entityGUID,
 String classificationName)

Retrieve a classification extension from the archive.

Specified by:

getClassification in interface OpenMetadataArchiveBuilder

Parameters:

entityGUID - unique identifier of entity

classificationName - name of the classification

Returns:

requested classification extension

queryClassification

public ClassificationEntityExtension queryClassification(String entityGUID,
 String classificationName)

Retrieve a classification extension from the archive.

Specified by:

queryClassification in interface OpenMetadataArchiveBuilder

Parameters:

entityGUID - unique identifier of entity

classificationName - name of the classification

Returns:

requested classification extension

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.