org.odpi.openmetadata.archiveutilities.openconnectors.base

Class OpenConnectorArchiveBuilder

java.lang.Object

org.odpi.openmetadata.archiveutilities.openconnectors.base.OpenConnectorArchiveBuilder

Direct Known Subclasses:

DataStoreConnectorsArchiveBuilder

public class OpenConnectorArchiveBuilder
extends Object

OpenConnectorArchiveBuilder creates the open metadata compliant instances for connectors that follow the Open Connector Framework (OCF).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OpenConnectorArchiveBuilder(String archiveGUID, String archiveName, String archiveDescription, OpenMetadataArchiveType archiveType, String archiveRootName, String originatorName, String originatorLicense, Date creationDate, long versionNumber, String versionName) Typical constructor passes parameters used to build the open metadata archive's property header.

Method Summary

Modifier and Type	Method and Description
protected String	addConnection(String qualifiedName, String displayName, String description, String userId, String clearPassword, String encryptedPassword, Map<String,String> securedProperties, Map<String,Object> configurationProperties, Map<String,String> additionalProperties, String connectorTypeGUID, String endpointGUID) Create a connection entity.
protected String	addConnectorType(String qualifiedName, String displayName, String description, String connectorProviderClassName, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, List<String> recognizedAdditionalProperties, Map<String,String> additionalProperties) Create a connector type entity.
protected String	addConnectorType(String connectorTypeGUID, String qualifiedName, String displayName, String description, String connectorProviderClassName, List<String> recognizedSecuredProperties, List<String> recognizedConfigurationProperties, List<String> recognizedAdditionalProperties, Map<String,String> additionalProperties) Create a connector type entity.
protected String	addEndpoint(String qualifiedName, String displayName, String description, String networkAddress, String protocol, Map<String,String> additionalProperties) Create a endpoint entity.
protected OpenMetadataArchive	getOpenMetadataArchive() Returns the open metadata type archive containing all of the content loaded by the subclass.
protected void	logBadArchiveContent(String methodName) Throws an exception if there is a problem building the archive.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OpenConnectorArchiveBuilder

protected OpenConnectorArchiveBuilder(String archiveGUID,
                                      String archiveName,
                                      String archiveDescription,
                                      OpenMetadataArchiveType archiveType,
                                      String archiveRootName,
                                      String originatorName,
                                      String originatorLicense,
                                      Date creationDate,
                                      long versionNumber,
                                      String versionName)

Typical constructor passes parameters used to build the open metadata archive's property header.

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.

archiveRootName - non-spaced root name of the open metadata archive elements.

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

originatorLicense - license for the content.

creationDate - data that this archive was created.

versionNumber - version number of the archive.

versionName - version name for the archive.

Method Detail

getOpenMetadataArchive

protected OpenMetadataArchive getOpenMetadataArchive()

Returns the open metadata type archive containing all of the content loaded by the subclass.

Returns:

populated open metadata archive object

logBadArchiveContent

protected void logBadArchiveContent(String methodName)

Throws an exception if there is a problem building the archive.

Parameters:

methodName - calling method

addConnection

protected String addConnection(String qualifiedName,
                               String displayName,
                               String description,
                               String userId,
                               String clearPassword,
                               String encryptedPassword,
                               Map<String,String> securedProperties,
                               Map<String,Object> configurationProperties,
                               Map<String,String> additionalProperties,
                               String connectorTypeGUID,
                               String endpointGUID)

Create a connection entity.

Parameters:

qualifiedName - unique name for the connection

displayName - display name for the connection

description - description about the connection

userId - userId that the connector should use to connect to the platform that hosts the asset.

clearPassword - possible password for the connector

encryptedPassword - possible password for the connector

securedProperties - properties hidden from the client

configurationProperties - properties used to configure the connector

additionalProperties - any other properties.

connectorTypeGUID - unique identifier for the connector type

endpointGUID - unique identifier for the endpoint of the asset

Returns:

id for the connection

addConnectorType

protected String addConnectorType(String connectorTypeGUID,
                                  String qualifiedName,
                                  String displayName,
                                  String description,
                                  String connectorProviderClassName,
                                  List<String> recognizedSecuredProperties,
                                  List<String> recognizedConfigurationProperties,
                                  List<String> recognizedAdditionalProperties,
                                  Map<String,String> additionalProperties)

Create a connector type entity.

Parameters:

connectorTypeGUID - fixed unique identifier for connector type - comes from the Connector Provider

qualifiedName - unique name for the connector type

displayName - display name for the connector type

description - description about the connector type

connectorProviderClassName - code for this type of connector

recognizedSecuredProperties - names of supported properties hidden from the client - for connection object.

recognizedConfigurationProperties - names of supported properties used to configure the connector - for connection object.

recognizedAdditionalProperties - names of any other properties for connection object.

additionalProperties - any other properties.

Returns:

id for the connector type

addConnectorType

protected String addConnectorType(String qualifiedName,
                                  String displayName,
                                  String description,
                                  String connectorProviderClassName,
                                  List<String> recognizedSecuredProperties,
                                  List<String> recognizedConfigurationProperties,
                                  List<String> recognizedAdditionalProperties,
                                  Map<String,String> additionalProperties)

Create a connector type entity.

Parameters:

qualifiedName - unique name for the connector type

displayName - display name for the connector type

description - description about the connector type

connectorProviderClassName - code for this type of connector

recognizedSecuredProperties - names of supported properties hidden from the client - for connection object.

recognizedConfigurationProperties - names of supported properties used to configure the connector - for connection object.

recognizedAdditionalProperties - names of any other properties for connection object.

additionalProperties - any other properties.

Returns:

id for the connector type

addEndpoint

protected String addEndpoint(String qualifiedName,
                             String displayName,
                             String description,
                             String networkAddress,
                             String protocol,
                             Map<String,String> additionalProperties)

Create a endpoint entity.

Parameters:

qualifiedName - unique name for the endpoint

displayName - display name for the endpoint

description - description about the endpoint

networkAddress - location of the asset

protocol - protocol to use to connect to the asset

additionalProperties - any other properties.

Returns:

id for the endpoint