Package org.odpi.openmetadata.samples.archiveutilities

Class GovernanceArchiveHelper

java.lang.Object

org.odpi.openmetadata.samples.archiveutilities.SimpleCatalogArchiveHelper

org.odpi.openmetadata.samples.archiveutilities.GovernanceArchiveHelper

public class GovernanceArchiveHelper
extends SimpleCatalogArchiveHelper

GovernanceArchiveHelper creates elements for governance. This includes governance program definitions, governance engine definitions and governance action process definitions.

Field Summary

Fields inherited from class org.odpi.openmetadata.samples.archiveutilities.SimpleCatalogArchiveHelper

API_HEADER_TYPE_NAME, API_REQUEST_TYPE_NAME, API_RESPONSE_TYPE_NAME, archiveBuilder, archiveHelper, archiveRootName, guidMapFileNamePostFix, idToGUIDMap, originatorName, versionName

Constructor Summary

Constructors

Constructor	Description
GovernanceArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveRootName, String originatorName, 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	Description
String	addGovernanceEngine(String typeName, String qualifiedName, String displayName, String description, String capabilityType, String capabilityVersion, String patchLevel, String source, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Create a software capability entity.
String	addGovernanceService(String typeName, String connectorProviderName, Map<String,Object> configurationProperties, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, Map<String,Object> extendedProperties)	Create a governance service entity.
void	addSupportedGovernanceService(String engineGUID, String requestType, Map<String,String> requestParameters, String serviceGUID)	Create the relationship between a governance engine and one of its its supported governance services.

Methods inherited from class org.odpi.openmetadata.samples.archiveutilities.SimpleCatalogArchiveHelper

addAPIOperation, addAPIParameterList, addAsset, addAttributeForSchemaType, addCategory, addCategoryHierarchy, addCategoryToCategory, addConnection, addConnectionForAsset, addConnectorCategory, addConnectorType, addConnectorType, addConnectorTypeDirectory, addDataContentForDataSet, addEndpoint, addGlossary, addHasARelationship, addIsATypeOfRelationship, addMoreInformationLink, addNestedSchemaAttribute, addRelatedTermRelationship, addSchemaAttribute, addSchemaTypeOption, addSoftwareCapability, addTerm, addTerm, addTopLevelSchemaType, linkTermToReferenceable, saveGUIDs

Methods inherited from class java.lang.Object

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

Constructor Detail

GovernanceArchiveHelper

public GovernanceArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder,
                               String archiveGUID,
                               String archiveRootName,
                               String originatorName,
                               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.

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

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

creationDate - data that this archive was created.

versionNumber - version number of the archive.

versionName - version name for the archive.

Method Detail

addGovernanceService

public String addGovernanceService(String typeName,
                                   String connectorProviderName,
                                   Map<String,Object> configurationProperties,
                                   String qualifiedName,
                                   String displayName,
                                   String description,
                                   Map<String,String> additionalProperties,
                                   Map<String,Object> extendedProperties)

Create a governance service entity.

Parameters:

typeName - name of governance service subtype to use - default is GovernanceService

connectorProviderName - name of the connector provider for the governance service

configurationProperties - configuration properties for the governance service (goes in the connection)

qualifiedName - unique name for the governance service

displayName - display name for the governance service

description - description about the governance service

additionalProperties - any other properties

extendedProperties - additional properties defined in the sub type

Returns:

id for the governance service

addGovernanceEngine

public String addGovernanceEngine(String typeName,
                                  String qualifiedName,
                                  String displayName,
                                  String description,
                                  String capabilityType,
                                  String capabilityVersion,
                                  String patchLevel,
                                  String source,
                                  Map<String,String> additionalProperties,
                                  Map<String,Object> extendedProperties)

Create a software capability entity.

Parameters:

typeName - name of software capability subtype to use - default is SoftwareCapability

qualifiedName - unique name for the capability

displayName - display name for the capability

description - description about the capability

additionalProperties - any other properties.

Returns:

id for the capability

addSupportedGovernanceService

public void addSupportedGovernanceService(String engineGUID,
                                          String requestType,
                                          Map<String,String> requestParameters,
                                          String serviceGUID)

Create the relationship between a governance engine and one of its its supported governance services.

Parameters:

engineGUID - unique identifier of the asset

requestType - governance request type to use when calling the service

requestParameters - default request parameters to pass to the service when called with this request type

serviceGUID - unique identifier of the service