Class GovernanceArchiveHelper
java.lang.Object
org.odpi.openmetadata.samples.archiveutilities.SimpleCatalogArchiveHelper
org.odpi.openmetadata.samples.archiveutilities.GovernanceArchiveHelper
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
activeStatus, ADDITIONAL_PROPERTIES_PROPERTY, API_HEADER_TYPE_NAME, API_REQUEST_TYPE_NAME, API_RESPONSE_TYPE_NAME, archiveBuilder, archiveHelper, archiveRootName, ASSET_OWNER_TYPE_NAME, BUSINESS_CAPABILITY_TYPE_BUSINESS_AREA, BUSINESS_CAPABILITY_TYPE_BUSINESS_SERVICE, BUSINESS_CAPABILITY_TYPE_OTHER, BUSINESS_CAPABILITY_TYPE_UNCLASSIFIED, BUSINESS_IMPERATIVE_TYPE_NAME, BUSINESS_OWNER_TYPE_NAME, CAMPAIGN_CLASSIFICATION_NAME, CERTIFICATION_TYPE_TYPE_NAME, COMMUNITY_MEMBER_TYPE_NAME, COMMUNITY_MEMBERSHIP_TYPE_ADMINISTRATOR, COMMUNITY_MEMBERSHIP_TYPE_CONTRIBUTOR, COMMUNITY_MEMBERSHIP_TYPE_LEADER, COMMUNITY_MEMBERSHIP_TYPE_OBSERVER, COMMUNITY_MEMBERSHIP_TYPE_OTHER, COMMUNITY_TYPE_NAME, COMPONENT_OWNER_TYPE_NAME, CONCEPT_BEAD_COVERAGE_CORE_DETAIL, CONCEPT_BEAD_COVERAGE_EXTENDED_DETAIL, CONCEPT_BEAD_COVERAGE_IDENTIFIER, CONCEPT_BEAD_COVERAGE_UNIQUE_IDENTIFIER, CONCEPT_BEAD_COVERAGE_UNKNOWN, CONCEPT_MODEL_DECORATION_AGGREGATION, CONCEPT_MODEL_DECORATION_COMPOSITION, CONCEPT_MODEL_DECORATION_EXTENSION, CONCEPT_MODEL_DECORATION_NONE, CONTACT_METHOD_TYPE_ACCOUNT, CONTACT_METHOD_TYPE_CHAT, CONTACT_METHOD_TYPE_EMAIL, CONTACT_METHOD_TYPE_OTHER, CONTACT_METHOD_TYPE_PHONE, CONTACT_METHOD_TYPE_PROFILE, DATA_ITEM_OWNER_TYPE_NAME, DATA_PROCESSING_PURPOSE_TYPE_NAME, DESCRIPTION_PROPERTY, DISPLAY_NAME_PROPERTY, DOMAIN_IDENTIFIER_PROPERTY, EXTERNAL_GLOSSARY_LINK_TYPE_NAME, GLOSSARY_PROJECT_CLASSIFICATION_NAME, GOVERNANCE_APPROACH_TYPE_NAME, GOVERNANCE_CLASSIFICATION_SET_CLASSIFICATION_NAME, GOVERNANCE_CONTROL_LINK_RELATIONSHIP_NAME, GOVERNANCE_CONTROL_TYPE_NAME, GOVERNANCE_DOMAIN_SET_CLASSIFICATION_NAME, GOVERNANCE_DRIVER_LINK_RELATIONSHIP_NAME, GOVERNANCE_DRIVER_TYPE_NAME, GOVERNANCE_IMPLEMENTATION_RELATIONSHIP_NAME, GOVERNANCE_OBLIGATION_TYPE_NAME, GOVERNANCE_OFFICER_TYPE_NAME, GOVERNANCE_POLICY_LINK_RELATIONSHIP_NAME, GOVERNANCE_POLICY_TYPE_NAME, GOVERNANCE_PRINCIPLE_TYPE_NAME, GOVERNANCE_PROCEDURE_TYPE_NAME, GOVERNANCE_PROCESS_IMPLEMENTATION_RELATIONSHIP_NAME, GOVERNANCE_PROCESS_TYPE_NAME, GOVERNANCE_PROJECT_CLASSIFICATION_NAME, GOVERNANCE_REPRESENTATIVE_TYPE_NAME, GOVERNANCE_RESPONSE_RELATIONSHIP_NAME, GOVERNANCE_RESPONSIBILITY_ASSIGNMENT_RELATIONSHIP_NAME, GOVERNANCE_RESPONSIBILITY_TYPE_NAME, GOVERNANCE_ROLE_TYPE_NAME, GOVERNANCE_RULE_IMPLEMENTATION_RELATIONSHIP_NAME, GOVERNANCE_RULE_TYPE_NAME, GOVERNANCE_STATUS_SET_CLASSIFICATION_NAME, GOVERNANCE_STRATEGY_TYPE_NAME, guidMapFileNamePostFix, idToGUIDMap, LICENSE_TYPE_TYPE_NAME, LOCATION_OWNER_TYPE_NAME, MEDIA_TYPE_AUDIO, MEDIA_TYPE_DOCUMENT, MEDIA_TYPE_IMAGE, MEDIA_TYPE_OTHER, MEDIA_TYPE_VIDEO, MEDIA_USAGE_ICON, MEDIA_USAGE_ILLUSTRATION, MEDIA_USAGE_OTHER, MEDIA_USAGE_THUMBNAIL, MEDIA_USAGE_USAGE_GUIDANCE, NAME_PROPERTY, NAMING_STANDARD_RULE_SET_TYPE_NAME, NAMING_STANDARD_RULE_TYPE_NAME, NOTE_LOG_AUTHOR_TYPE_NAME, ORGANIZATION_TYPE_NAME, ORGANIZATIONAL_CONTROL_TYPE_NAME, originatorName, PROJECT_MANAGER_TYPE_NAME, PROJECT_TYPE_NAME, QUALIFIED_NAME_PROPERTY, REGULATION_ARTICLE_TYPE_NAME, REGULATION_TYPE_NAME, RELATED_MEDIA_TYPE_NAME, SECURITY_GROUP_TYPE_NAME, SOLUTION_OWNER_TYPE_NAME, SUBJECT_AREA_OWNER_TYPE_NAME, TASK_CLASSIFICATION_NAME, TEAM_LEADER_TYPE_NAME, TEAM_MEMBER_TYPE_NAME, TECHNICAL_CONTROL_TYPE_NAME, TERM_RELATIONSHIP_STATUS_ACTIVE, TERM_RELATIONSHIP_STATUS_DEPRECATED, TERM_RELATIONSHIP_STATUS_DRAFT, TERM_RELATIONSHIP_STATUS_OBSOLETE, TERM_RELATIONSHIP_STATUS_OTHER, THREAT_TYPE_NAME, VALID_VALUE_DEFINITION_TYPE_NAME, VALID_VALUE_SET_TYPE_NAME, VERSION_IDENTIFIER_PROPERTY, versionName
-
Constructor Summary
ConstructorsConstructorDescriptionGovernanceArchiveHelper
(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.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.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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addGovernanceActionFlow
(String governanceActionProcessGUID, String guard, String governanceActionTypeGUID) Create the relationship between a governance action process and the first governance action type to execute.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.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.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.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.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.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
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.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.Methods inherited from class org.odpi.openmetadata.samples.archiveutilities.SimpleCatalogArchiveHelper
addAPIOperation, addAPIParameter, addAPIParameterList, addAsset, addAsset, addAsset, addAsset, addAsset, addAssetLocationRelationship, addAssetZoneMembershipClassification, addAssignmentScopeRelationship, addAttributeForSchemaType, addBusinessArea, addCategory, addCategory, addCategoryToCategory, addCollection, addCommunity, addCommunityMembershipRelationship, addConceptBeadAttributeLink, addConceptBeadRelationshipEnd, addConnection, addConnectionForAsset, addConnectorCategory, addConnectorType, addConnectorType, addConnectorTypeDirectory, addContactDetails, addCyberLocation, addDataContentForDataSet, addDataContentForDataSet, addDesignModel, addDesignModelElement, addDesignModelGroupMembership, addEndpoint, addExternalReference, addExternalReferenceLink, addFixedLocation, addGlossary, addGlossary, addGovernanceDefinition, addGovernanceDefinitionDelegationRelationship, addGovernanceDefinitionPeerRelationship, addGovernanceDefinitionScopeRelationship, addGovernanceDomainDescription, addGovernanceRole, addGovernanceZone, addGovernedByRelationship, addHasARelationship, addIsATypeOfRelationship, addITProfileToAsset, addLibraryCategoryReference, addLibraryTermReference, addLocation, addLocationHierarchy, addMediaReference, addMediaReferenceLink, addMemberToCollection, addMobileAssetClassification, addMoreInformationLink, addNestedSchemaAttribute, addOrganizationalCapabilityRelationship, addPeerLocations, addPeerRelationship, addPerson, addPersonRole, addPersonRoleAppointmentRelationship, addProcess, addProcess, addProfileIdentity, addProfileLocationRelationship, addProject, addProjectDependencyRelationship, addProjectHierarchyRelationship, addProjectManagementRelationship, addProjectTeamRelationship, addReferenceDataClassification, addReferenceValueAssignmentRelationship, addRelatedTermRelationship, addResourceListRelationship, addSchemaAttribute, addSchemaTypeOption, addSecureLocation, addSecurityTagsClassification, addSoftwareCapability, addStakeHolderRelationship, addSubjectAreaClassification, addSubjectAreaDefinition, addSubjectAreaHierarchy, addTeam, addTeamLeadershipRelationship, addTeamMembershipRelationship, addTeamStructureRelationship, addTerm, addTerm, addTermToCategory, addTermToCategory, addTermToContext, addTermToSynonym, addTopLevelSchemaType, addUserIdentity, addValidValue, addValidValueMembershipRelationship, addValidValuesAssignmentRelationship, addValidValuesImplementationRelationship, addValidValuesMappingRelationship, addZoneHierarchy, getGUID, linkTermToReferenceable, queryGUID, saveGUIDs
-
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 cachedarchiveGUID
- 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 cachedarchiveGUID
- 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 cachedarchiveGUID
- 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 GovernanceServiceconnectorProviderName
- name of the connector provider for the governance serviceconfigurationProperties
- configuration properties for the governance service (goes in the connection)qualifiedName
- unique name for the governance servicedisplayName
- display name for the governance servicedescription
- description about the governance serviceadditionalProperties
- any other propertiesextendedProperties
- 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 SoftwareCapabilityqualifiedName
- unique name for the capabilitydisplayName
- display name for the capabilitydescription
- description about the capabilitycapabilityType
- typecapabilityVersion
- versionpatchLevel
- patch levelsource
- sourceadditionalProperties
- any other propertiesextendedProperties
- 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 assetrequestType
- governance request type to use when calling the governance engineserviceRequestType
- 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 typeserviceGUID
- 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 GovernanceActionProcessqualifiedName
- unique name for the capabilityname
- display name for the capabilitydescription
- description about the capabilityformula
- logic for the processdomainIdentifier
- which governance domain - 0=alladditionalProperties
- any other propertiesextendedProperties
- properties for subtypeclassifications
- 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 GovernanceActionProcessqualifiedName
- unique name for the capabilityname
- display name for the capabilityversionIdentifier
- identifier of the version for the process implementationdescription
- description about the capabilityformula
- logic for the processdomainIdentifier
- which governance domain - 0=alladditionalProperties
- any other propertiesextendedProperties
- properties for subtypeclassifications
- 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 GovernanceActionTypequalifiedName
- unique name for the capabilitydisplayName
- display name for the capabilitydescription
- description about the capabilityproducedGuards
- guards expected from the implementationdomainIdentifier
- which governance domain - 0=alladditionalProperties
- any other propertiesextendedProperties
- properties for subtypeclassifications
- 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 processguard
- initial guard for the first step in the processgovernanceActionTypeGUID
- 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 typeguard
- guard required to run this next actionmandatoryGuard
- guard must occur before the next step can runignoreMultipleTriggers
- only run this once even if the same guard occurs multiple times while it is waitingnextGovernanceActionTypeGUID
- 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 typerequestType
- governance request type to use when calling the enginerequestParameters
- default request parameters to pass to the service when called with this request typegovernanceEngineGUID
- unique identifier of the implementing governance engine
-