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.
  • Constructor Details

    • 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:
      archiveBuilder - builder where content is cached
      archiveGUID - unique identifier for this open metadata archive.
      archiveRootName - non-spaced root name of the open metadata GUID map.
      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.
    • GovernanceArchiveHelper

      public GovernanceArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveName, 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:
      archiveBuilder - builder where content is cached
      archiveGUID - unique identifier for this open metadata archive.
      archiveName - name of the open metadata archive metadata collection.
      archiveRootName - non-spaced root name of the open metadata GUID map.
      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.
    • GovernanceArchiveHelper

      public GovernanceArchiveHelper(OpenMetadataArchiveBuilder archiveBuilder, String archiveGUID, String archiveRootName, String originatorName, Date creationDate, long versionNumber, String versionName, String guidMapFileName)
      Constructor passes parameters used to build the open metadata archive's property header. This version is used for multiple dependant archives, and they need to share the guid map.
      Parameters:
      archiveBuilder - builder where content is cached
      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.
      guidMapFileName - name of the guid map file.
  • Method Details

    • 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 subtype
      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 got s governance engine.
      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
      capabilityType - type
      capabilityVersion - version
      patchLevel - patch level
      source - source
      additionalProperties - any other properties
      extendedProperties - properties for subtype
      Returns:
      id for the capability
    • addSupportedGovernanceService

      public void addSupportedGovernanceService(String engineGUID, String requestType, String serviceRequestType, Map<String,String> requestParameters, String serviceGUID)
      Create the relationship between a governance engine and one of its supported governance services.
      Parameters:
      engineGUID - unique identifier of the asset
      requestType - governance request type to use when calling the governance engine
      serviceRequestType - request type to use when calling the service (if null, governance request type is used)
      requestParameters - default request parameters to pass to the service when called with this request type
      serviceGUID - unique identifier of the service
    • addGovernanceActionProcess

      public String addGovernanceActionProcess(String typeName, String qualifiedName, String name, String description, String formula, int domainIdentifier, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, List<Classification> classifications)
      Create a governance action process.
      Parameters:
      typeName - name of process subtype to use - default is GovernanceActionProcess
      qualifiedName - unique name for the capability
      name - display name for the capability
      description - description about the capability
      formula - logic for the process
      domainIdentifier - which governance domain - 0=all
      additionalProperties - any other properties
      extendedProperties - properties for subtype
      classifications - list of classifications (if any)
      Returns:
      id for the new entity
    • addGovernanceActionProcess

      public String addGovernanceActionProcess(String typeName, String qualifiedName, String name, String versionIdentifier, String description, String formula, int domainIdentifier, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, List<Classification> classifications)
      Create a governance action process.
      Parameters:
      typeName - name of process subtype to use - default is GovernanceActionProcess
      qualifiedName - unique name for the capability
      name - display name for the capability
      versionIdentifier - identifier of the version for the process implementation
      description - description about the capability
      formula - logic for the process
      domainIdentifier - which governance domain - 0=all
      additionalProperties - any other properties
      extendedProperties - properties for subtype
      classifications - list of classifications (if any)
      Returns:
      id for the new entity
    • addGovernanceActionType

      public String addGovernanceActionType(String typeName, String qualifiedName, String displayName, String description, int domainIdentifier, List<String> producedGuards, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, List<Classification> classifications)
      Create a governance action type.
      Parameters:
      typeName - name of subtype to use - default is GovernanceActionType
      qualifiedName - unique name for the capability
      displayName - display name for the capability
      description - description about the capability
      producedGuards - guards expected from the implementation
      domainIdentifier - which governance domain - 0=all
      additionalProperties - any other properties
      extendedProperties - properties for subtype
      classifications - list of classifications (if any)
      Returns:
      id for the new entity
    • addGovernanceActionFlow

      public void addGovernanceActionFlow(String governanceActionProcessGUID, String guard, String governanceActionTypeGUID)
      Create the relationship between a governance action process and the first governance action type to execute.
      Parameters:
      governanceActionProcessGUID - unique identifier of the governance action process
      guard - initial guard for the first step in the process
      governanceActionTypeGUID - unique identifier of the implementing governance engine
    • addNextGovernanceActionType

      public void addNextGovernanceActionType(String governanceActionTypeGUID, String guard, boolean mandatoryGuard, boolean ignoreMultipleTriggers, String nextGovernanceActionTypeGUID)
      Create the relationship between a governance action type and one of the next governance action type to execute in a process.
      Parameters:
      governanceActionTypeGUID - unique identifier of the governance action type
      guard - guard required to run this next action
      mandatoryGuard - guard must occur before the next step can run
      ignoreMultipleTriggers - only run this once even if the same guard occurs multiple times while it is waiting
      nextGovernanceActionTypeGUID - unique identifier of the implementing governance engine
    • addGovernanceActionTypeExecutor

      public void addGovernanceActionTypeExecutor(String governanceActionTypeGUID, String requestType, Map<String,String> requestParameters, String governanceEngineGUID)
      Create the relationship between a governance action type and the governance engine that supplies its implementation.
      Parameters:
      governanceActionTypeGUID - unique identifier of the governance action type
      requestType - governance request type to use when calling the engine
      requestParameters - default request parameters to pass to the service when called with this request type
      governanceEngineGUID - unique identifier of the implementing governance engine