Class 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 Detail

      • GovernanceArchiveHelper

        public GovernanceArchiveHelper​(OpenMetadataArchiveBuilder archiveBuilder,
                                       java.lang.String archiveGUID,
                                       java.lang.String archiveRootName,
                                       java.lang.String originatorName,
                                       java.util.Date creationDate,
                                       long versionNumber,
                                       java.lang.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 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.
      • GovernanceArchiveHelper

        public GovernanceArchiveHelper​(OpenMetadataArchiveBuilder archiveBuilder,
                                       java.lang.String archiveGUID,
                                       java.lang.String archiveRootName,
                                       java.lang.String originatorName,
                                       java.util.Date creationDate,
                                       long versionNumber,
                                       java.lang.String versionName,
                                       java.lang.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 Detail

      • addGovernanceService

        public java.lang.String addGovernanceService​(java.lang.String typeName,
                                                     java.lang.String connectorProviderName,
                                                     java.util.Map<java.lang.String,​java.lang.Object> configurationProperties,
                                                     java.lang.String qualifiedName,
                                                     java.lang.String displayName,
                                                     java.lang.String description,
                                                     java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                     java.util.Map<java.lang.String,​java.lang.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 java.lang.String addGovernanceEngine​(java.lang.String typeName,
                                                    java.lang.String qualifiedName,
                                                    java.lang.String displayName,
                                                    java.lang.String description,
                                                    java.lang.String capabilityType,
                                                    java.lang.String capabilityVersion,
                                                    java.lang.String patchLevel,
                                                    java.lang.String source,
                                                    java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                    java.util.Map<java.lang.String,​java.lang.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​(java.lang.String engineGUID,
                                                  java.lang.String requestType,
                                                  java.util.Map<java.lang.String,​java.lang.String> requestParameters,
                                                  java.lang.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 service
        requestParameters - default request parameters to pass to the service when called with this request type
        serviceGUID - unique identifier of the service
      • addGovernanceActionProcess

        public java.lang.String addGovernanceActionProcess​(java.lang.String typeName,
                                                           java.lang.String qualifiedName,
                                                           java.lang.String displayName,
                                                           java.lang.String description,
                                                           java.lang.String formula,
                                                           int domainIdentifier,
                                                           java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                           java.util.Map<java.lang.String,​java.lang.Object> extendedProperties,
                                                           java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.Classification> classifications)
        Create a governance action process.
        Parameters:
        typeName - name of process subtype to use - default is GovernanceActionProcess
        qualifiedName - unique name for the capability
        displayName - 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
      • addGovernanceActionType

        public java.lang.String addGovernanceActionType​(java.lang.String typeName,
                                                        java.lang.String qualifiedName,
                                                        java.lang.String displayName,
                                                        java.lang.String description,
                                                        int domainIdentifier,
                                                        java.util.List<java.lang.String> producedGuards,
                                                        java.util.Map<java.lang.String,​java.lang.String> additionalProperties,
                                                        java.util.Map<java.lang.String,​java.lang.Object> extendedProperties,
                                                        java.util.List<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.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​(java.lang.String governanceActionProcessGUID,
                                            java.lang.String guard,
                                            java.lang.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​(java.lang.String governanceActionTypeGUID,
                                                java.lang.String guard,
                                                boolean mandatoryGuard,
                                                boolean ignoreMultipleTriggers,
                                                java.lang.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​(java.lang.String governanceActionTypeGUID,
                                                    java.lang.String requestType,
                                                    java.util.Map<java.lang.String,​java.lang.String> requestParameters,
                                                    java.lang.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