Package org.odpi.openmetadata.frameworks.governanceaction.client

Interface SpecialGovernanceActionInterface

All Known Implementing Classes:
OpenGovernanceClient, WatchDogEventClient
public interface SpecialGovernanceActionInterface
SpecialGovernanceActionInterface defines methods that are used by governance services to make changes to open metadata.

  • Method Details

    • initiateGovernanceAction

      String initiateGovernanceAction(String userId, String qualifiedName, int domainIdentifier, String displayName, String description, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, List<String> receivedGuards, Date startTime, String governanceEngineName, String requestType, Map<String,String> requestParameters, String processName, String requestSourceName, String originatorServiceName, String originatorEngineName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create a governance action in the metadata store which will trigger the governance action service associated with the supplied request type. The governance action remains to act as a record of the actions taken for auditing.
      Parameters:
      userId - caller's userId
      qualifiedName - unique identifier to give this governance action
      domainIdentifier - governance domain associated with this action (0=ALL)
      displayName - display name for this action
      description - description for this action
      requestSourceGUIDs - request source elements for the resulting governance action service
      actionTargets - list of action target names to GUIDs for the resulting governance action service
      receivedGuards - list of guards to initiate the governance action
      startTime - future start time or null for "as soon as possible"
      governanceEngineName - name of the governance engine that should execute the request
      requestType - request type to identify the governance action service to run
      requestParameters - properties to pass to the governance action service
      processName - name of the process that this action is a part of
      requestSourceName - source of the request
      originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
      originatorEngineName - optional unique name of the requesting governance engine (if initiated by a governance engine).
      Returns:
      unique identifier of the governance action
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null qualified name
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this governance action service is not authorized to create a governance action
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • initiateGovernanceActionProcess

      String initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Using the named governance action process as a template, initiate a chain of governance actions.
      Parameters:
      userId - caller's userId
      processQualifiedName - unique name of the governance action process to use
      requestSourceGUIDs - request source elements for the resulting governance action service
      actionTargets - map of action target names to GUIDs for the resulting governance action service
      startTime - future start time or null for "as soon as possible"
      requestParameters - request properties to be passed to the first governance action
      originatorServiceName - unique name of the requesting governance service (if initiated by a governance engine).
      originatorEngineName - optional unique name of the governance engine (if initiated by a governance engine).
      Returns:
      unique identifier of the first governance action of the process
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null or unrecognized qualified name of the process
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this governance action service is not authorized to create a governance action process
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • linkElementsAsPeerDuplicates

      void linkElementsAsPeerDuplicates(String userId, String metadataElement1GUID, String metadataElement2GUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, boolean setKnownDuplicate) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
      Parameters:
      userId - caller's userId
      metadataElement1GUID - unique identifier of the metadata element at end 1 of the relationship
      metadataElement2GUID - unique identifier of the metadata element at end 2 of the relationship
      statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
      steward - identifier of the steward
      stewardTypeName - type of element used to identify the steward
      stewardPropertyName - property name used to identify steward
      source - source of the duplicate detection processing
      notes - notes for the steward
      setKnownDuplicate - boolean flag indicating whether the KnownDuplicate classification should be set on the linked entities.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

    • linkConsolidatedDuplicate

      void linkConsolidatedDuplicate(String userId, String consolidatedElementGUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes, List<String> sourceElementGUIDs) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.)
      Parameters:
      userId - caller's userId
      consolidatedElementGUID - unique identifier of the metadata element
      statusIdentifier - what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)
      steward - identifier of the steward
      stewardTypeName - type of element used to identify the steward
      stewardPropertyName - property name used to identify steward
      source - source of the duplicate detection processing
      notes - notes for the steward
      sourceElementGUIDs - List of the source elements that must be linked to the consolidated element. It is assumed that they already have the KnownDuplicateClassification.
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier's of the metadata elements are null or invalid in some way; the properties are not valid for this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store