Package org.odpi.openmetadata.accessservices.governanceengine.client

Class GovernanceEngineClient

    • Constructor Detail

      • GovernanceEngineClient

        public GovernanceEngineClient​(String serverName,
                              String serverPlatformURLRoot)
                       throws InvalidParameterException
        Create a new client with no authentication embedded in the HTTP request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

      • GovernanceEngineClient

        public GovernanceEngineClient​(String serverName,
                              String serverPlatformURLRoot,
                              String serverUserId,
                              String serverPassword)
                       throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        serverUserId - caller's userId embedded in all HTTP requests
        serverPassword - caller's userId embedded in all HTTP requests
        Throws:
        InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

      • GovernanceEngineClient

        public GovernanceEngineClient​(String serverName,
                              String serverPlatformURLRoot,
                              GovernanceEngineRESTClient restClient,
                              int maxPageSize)
                       throws InvalidParameterException
        Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
        Parameters:
        serverName - name of the server to connect to
        serverPlatformURLRoot - the network address of the server running the OMAS REST servers
        restClient - pre-initialized REST client
        maxPageSize - pre-initialized parameter limit
        Throws:
        InvalidParameterException - there is a problem with the information about the remote OMAS

    • Method Detail

      • getMetadataElementByUniqueName

        public OpenMetadataElement getMetadataElementByUniqueName​(String userId,
                                                          String uniqueName,
                                                          String uniquePropertyName,
                                                          boolean forLineage,
                                                          boolean forDuplicateProcessing,
                                                          Date effectiveTime)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException
        Retrieve the metadata element using its unique name (typically the qualified name).
        Specified by:
        getMetadataElementByUniqueName in interface MetadataElementInterface
        Parameters:
        uniqueName - unique name for the metadata element
        uniquePropertyName - name of property name to test in the open metadata element - if null "qualifiedName" is used
        forLineage - the retrieved element is for lineage processing so include archived elements
        forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
        effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
        Returns:
        metadata element properties
        Throws:
        InvalidParameterException - the unique identifier is null or not known.
        UserNotAuthorizedException - the governance action service is not able to access the element
        PropertyServerException - there is a problem accessing the metadata store

      • getMetadataElementGUIDByUniqueName

        public String getMetadataElementGUIDByUniqueName​(String userId,
                                                 String uniqueName,
                                                 String uniquePropertyName,
                                                 boolean forLineage,
                                                 boolean forDuplicateProcessing,
                                                 Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException
        Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
        Specified by:
        getMetadataElementGUIDByUniqueName in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        uniqueName - unique name for the metadata element
        uniquePropertyName - name of property name to test in the open metadata element - if null "qualifiedName" is used
        forLineage - the retrieved element is for lineage processing so include archived elements
        forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
        effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
        Returns:
        metadata element unique identifier (guid)
        Throws:
        InvalidParameterException - the unique identifier is null or not known.
        UserNotAuthorizedException - the governance action service is not able to access the element
        PropertyServerException - there is a problem accessing the metadata store

      • findMetadataElementsWithString

        public List<OpenMetadataElement> findMetadataElementsWithString​(String userId,
                                                                String searchString,
                                                                boolean forLineage,
                                                                boolean forDuplicateProcessing,
                                                                Date effectiveTime,
                                                                int startFrom,
                                                                int pageSize)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException
        Retrieve the metadata elements that contain the requested string.
        Specified by:
        findMetadataElementsWithString in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        searchString - name to retrieve
        forLineage - the retrieved elements are for lineage processing so include archived elements
        forDuplicateProcessing - the retrieved elements are for duplicate processing so do not combine results from known duplicates.
        effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements (or null if no elements match the name)
        Throws:
        InvalidParameterException - the qualified name is null
        UserNotAuthorizedException - the governance action service is not able to access the element
        PropertyServerException - there is a problem accessing the metadata store

      • getRelatedMetadataElements

        public List<RelatedMetadataElement> getRelatedMetadataElements​(String userId,
                                                               String elementGUID,
                                                               int startingAtEnd,
                                                               String relationshipTypeName,
                                                               boolean forLineage,
                                                               boolean forDuplicateProcessing,
                                                               Date effectiveTime,
                                                               int startFrom,
                                                               int pageSize)
                                                        throws InvalidParameterException,
                                                               UserNotAuthorizedException,
                                                               PropertyServerException
        Retrieve the metadata elements connected to the supplied element.
        Specified by:
        getRelatedMetadataElements in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        elementGUID - unique identifier for the starting metadata element
        startingAtEnd - indicates which end to retrieve from (0 is "either end"; 1 is end1; 2 is end 2)
        relationshipTypeName - type name of relationships to follow (or null for all)
        forLineage - the retrieved element is for lineage processing so include archived elements
        forDuplicateProcessing - the retrieved elements are for duplicate processing so do not combine results from known duplicates.
        effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of related elements
        Throws:
        InvalidParameterException - the unique identifier is null or not known; the relationship type is invalid
        UserNotAuthorizedException - the governance action service is not able to access the elements
        PropertyServerException - there is a problem accessing the metadata store

      • findMetadataElements

        public List<OpenMetadataElement> findMetadataElements​(String userId,
                                                      String metadataElementTypeName,
                                                      List<String> metadataElementSubtypeName,
                                                      SearchProperties searchProperties,
                                                      List<ElementStatus> limitResultsByStatus,
                                                      SearchClassifications matchClassifications,
                                                      String sequencingProperty,
                                                      SequencingOrder sequencingOrder,
                                                      boolean forLineage,
                                                      boolean forDuplicateProcessing,
                                                      Date effectiveTime,
                                                      int startFrom,
                                                      int pageSize)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException
        Return a list of metadata elements that match the supplied criteria. The results can be returned over many pages.
        Specified by:
        findMetadataElements in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementTypeName - type of interest (null means any element type)
        metadataElementSubtypeName - optional list of the subtypes of the metadataElementTypeName to include in the search results. Null means all subtypes.
        searchProperties - Optional list of entity property conditions to match.
        limitResultsByStatus - By default, entities in all statuses (other than DELETE) are returned. However, it is possible to specify a list of statuses (eg ACTIVE) to restrict the results to. Null means all status values.
        matchClassifications - Optional list of classifications to match.
        sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).
        sequencingOrder - Enum defining how the results should be ordered.
        forLineage - the retrieved element is for lineage processing so include archived elements
        forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
        effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        a list of elements matching the supplied criteria; null means no matching elements in the metadata store.
        Throws:
        InvalidParameterException - one of the search parameters are is invalid
        UserNotAuthorizedException - the governance action service is not able to access the elements
        PropertyServerException - there is a problem accessing the metadata store

      • findRelationshipsBetweenMetadataElements

        public List<RelatedMetadataElements> findRelationshipsBetweenMetadataElements​(String userId,
                                                                              String relationshipTypeName,
                                                                              SearchProperties searchProperties,
                                                                              String sequencingProperty,
                                                                              SequencingOrder sequencingOrder,
                                                                              boolean forLineage,
                                                                              boolean forDuplicateProcessing,
                                                                              Date effectiveTime,
                                                                              int startFrom,
                                                                              int pageSize)
                                                                       throws InvalidParameterException,
                                                                              UserNotAuthorizedException,
                                                                              PropertyServerException
        Return a list of relationships that match the requested conditions. The results can be received as a series of pages.
        Specified by:
        findRelationshipsBetweenMetadataElements in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        relationshipTypeName - relationship's type. Null means all types (but may be slow so not recommended).
        searchProperties - Optional list of relationship property conditions to match.
        sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).
        sequencingOrder - Enum defining how the results should be ordered.
        forLineage - the retrieved elements are for lineage processing so include archived elements
        forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
        effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        a list of relationships. Null means no matching relationships.
        Throws:
        InvalidParameterException - one of the search parameters are is invalid
        UserNotAuthorizedException - the governance action service is not able to access the elements
        PropertyServerException - there is a problem accessing the metadata store

      • createMetadataElementInStore

        public String createMetadataElementInStore​(String userId,
                                           String metadataElementTypeName,
                                           ElementStatus initialStatus,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           ElementProperties properties,
                                           String templateGUID)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Create a new metadata element in the metadata store. The type name comes from the open metadata types. The selected type also controls the names and types of the properties that are allowed. This version of the method allows access to advanced features such as multiple states and effectivity dates.
        Specified by:
        createMetadataElementInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementTypeName - type name of the new metadata element
        initialStatus - initial status of the metadata element
        effectiveFrom - the date when this element is active - null for active on creation
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        properties - properties of the new metadata element
        templateGUID - the unique identifier of the existing asset to copy (this will copy all the attachments such as nested content, schema connection etc)
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - the type name, status or one of the properties is invalid
        UserNotAuthorizedException - the governance action service is not authorized to create this type of element
        PropertyServerException - there is a problem with the metadata store

      • updateMetadataElementInStore

        public void updateMetadataElementInStore​(String userId,
                                         String metadataElementGUID,
                                         boolean replaceProperties,
                                         boolean forLineage,
                                         boolean forDuplicateProcessing,
                                         ElementProperties properties,
                                         Date effectiveTime)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Update the properties of a specific metadata element. The properties must match the type definition associated with the metadata element when it was created. However, it is possible to update a few properties, or replace all them by the value used in the replaceProperties flag.
        Specified by:
        updateMetadataElementInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        properties - new properties for the metadata element
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - either the unique identifier or the properties are invalid in some way
        UserNotAuthorizedException - the governance action service is not authorized to update this element
        PropertyServerException - there is a problem with the metadata store

      • updateMetadataElementStatusInStore

        public void updateMetadataElementStatusInStore​(String userId,
                                               String metadataElementGUID,
                                               boolean forLineage,
                                               boolean forDuplicateProcessing,
                                               ElementStatus newElementStatus,
                                               Date effectiveTime)
                                        throws InvalidParameterException,
                                               UserNotAuthorizedException,
                                               PropertyServerException
        Update the status of specific metadata element. The new status must match a status value that is defined for the element's type assigned when it was created. The effectivity dates control the visibility of the element through specific APIs.
        Specified by:
        updateMetadataElementStatusInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        newElementStatus - new status value - or null to leave as is
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - either the unique identifier or the status are invalid in some way
        UserNotAuthorizedException - the governance action service is not authorized to update this element
        PropertyServerException - there is a problem with the metadata store

      • updateMetadataElementEffectivityInStore

        public void updateMetadataElementEffectivityInStore​(String userId,
                                                    String metadataElementGUID,
                                                    boolean forLineage,
                                                    boolean forDuplicateProcessing,
                                                    Date effectiveFrom,
                                                    Date effectiveTo,
                                                    Date effectiveTime)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Update the status of specific metadata element. The new status must match a status value that is defined for the element's type assigned when it was created. The effectivity dates control the visibility of the element through specific APIs.
        Specified by:
        updateMetadataElementEffectivityInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        effectiveFrom - the date when this element is active - null for active now
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - either the unique identifier or the status are invalid in some way
        UserNotAuthorizedException - the governance action service is not authorized to update this element
        PropertyServerException - there is a problem with the metadata store

      • classifyMetadataElementInStore

        public void classifyMetadataElementInStore​(String userId,
                                           String metadataElementGUID,
                                           String classificationName,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           ElementProperties properties,
                                           Date effectiveTime)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Add a new classification to the metadata element. Note that only one classification with the same name can be attached to a metadata element.
        Specified by:
        classifyMetadataElementInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        classificationName - name of the classification to add (if the classification is already present then use reclassify)
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        effectiveFrom - the date when this classification is active - null for active now
        effectiveTo - the date when this classification becomes inactive - null for active until deleted
        properties - properties to store in the new classification. These must conform to the valid properties associated with the classification name
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition
        UserNotAuthorizedException - the governance action service is not authorized to update this element
        PropertyServerException - there is a problem with the metadata store

      • reclassifyMetadataElementInStore

        public void reclassifyMetadataElementInStore​(String userId,
                                             String metadataElementGUID,
                                             String classificationName,
                                             boolean replaceProperties,
                                             boolean forLineage,
                                             boolean forDuplicateProcessing,
                                             ElementProperties properties,
                                             Date effectiveTime)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Update the properties of a classification that is currently attached to a specific metadata element.
        Specified by:
        reclassifyMetadataElementInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        classificationName - unique name of the classification to update
        replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        properties - new properties for the classification
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - the unique identifier or classification name is null or invalid in some way; properties do not match the valid properties associated with the classification's type definition
        UserNotAuthorizedException - the governance action service is not authorized to update this element/classification
        PropertyServerException - there is a problem with the metadata store

      • updateClassificationEffectivityInStore

        public void updateClassificationEffectivityInStore​(String userId,
                                                   String metadataElementGUID,
                                                   String classificationName,
                                                   boolean forLineage,
                                                   boolean forDuplicateProcessing,
                                                   Date effectiveFrom,
                                                   Date effectiveTo,
                                                   Date effectiveTime)
                                            throws InvalidParameterException,
                                                   UserNotAuthorizedException,
                                                   PropertyServerException
        Update the effectivity dates of a specific classification attached to a metadata element. The effectivity dates control the visibility of the classification through specific APIs.
        Specified by:
        updateClassificationEffectivityInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        classificationName - unique name of the classification to update
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        effectiveFrom - the date when this element is active - null for active now
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - either the unique identifier or the status are invalid in some way
        UserNotAuthorizedException - the governance action service is not authorized to update this element
        PropertyServerException - there is a problem with the metadata store

      • unclassifyMetadataElementInStore

        public void unclassifyMetadataElementInStore​(String userId,
                                             String metadataElementGUID,
                                             String classificationName,
                                             boolean forLineage,
                                             boolean forDuplicateProcessing,
                                             Date effectiveTime)
                                      throws InvalidParameterException,
                                             UserNotAuthorizedException,
                                             PropertyServerException
        Remove the named classification from a specific metadata element.
        Specified by:
        unclassifyMetadataElementInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        metadataElementGUID - unique identifier of the metadata element to update
        classificationName - unique name of the classification to remove
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - the unique identifier or classification name is null or invalid in some way
        UserNotAuthorizedException - the governance action service is not authorized to remove this classification
        PropertyServerException - there is a problem with the metadata store

      • createRelatedElementsInStore

        public String createRelatedElementsInStore​(String userId,
                                           String relationshipTypeName,
                                           String metadataElement1GUID,
                                           String metadataElement2GUID,
                                           boolean forLineage,
                                           boolean forDuplicateProcessing,
                                           Date effectiveFrom,
                                           Date effectiveTo,
                                           ElementProperties properties,
                                           Date effectiveTime)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
        Create a relationship between two metadata elements. It is important to put the right element at each end of the relationship according to the type definition since this will affect how the relationship is interpreted.
        Specified by:
        createRelatedElementsInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        relationshipTypeName - name of the type of relationship to create. This will determine the types of metadata elements that can be related and the properties that can be associated with this relationship.
        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
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        effectiveFrom - the date when this element is active - null for active now
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        properties - the properties of the relationship
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Returns:
        unique identifier of the new relationship
        Throws:
        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
        UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
        PropertyServerException - there is a problem with the metadata store

      • updateRelatedElementsInStore

        public void updateRelatedElementsInStore​(String userId,
                                         String relationshipGUID,
                                         boolean replaceProperties,
                                         boolean forLineage,
                                         boolean forDuplicateProcessing,
                                         ElementProperties properties,
                                         Date effectiveTime)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Update the properties associated with a relationship.
        Specified by:
        updateRelatedElementsInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        relationshipGUID - unique identifier of the relationship to update
        replaceProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        properties - new properties for the relationship
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - the unique identifier of the relationship is null or invalid in some way; the properties are not valid for this type of relationship
        UserNotAuthorizedException - the governance action service is not authorized to update this relationship
        PropertyServerException - there is a problem with the metadata store

      • updateRelatedElementsEffectivityInStore

        public void updateRelatedElementsEffectivityInStore​(String userId,
                                                    String relationshipGUID,
                                                    boolean forLineage,
                                                    boolean forDuplicateProcessing,
                                                    Date effectiveFrom,
                                                    Date effectiveTo,
                                                    Date effectiveTime)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Update the effectivity dates of a specific relationship between metadata elements. The effectivity dates control the visibility of the classification through specific APIs.
        Specified by:
        updateRelatedElementsEffectivityInStore in interface MetadataElementInterface
        Parameters:
        userId - caller's userId
        relationshipGUID - unique identifier of the relationship to update
        forLineage - the query is to support lineage retrieval
        forDuplicateProcessing - the query is for duplicate processing and so must not deduplicate
        effectiveFrom - the date when this element is active - null for active now
        effectiveTo - the date when this element becomes inactive - null for active until deleted
        effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
        Throws:
        InvalidParameterException - either the unique identifier or the status are invalid in some way
        UserNotAuthorizedException - the governance action service is not authorized to update this element
        PropertyServerException - there is a problem with the metadata store

      • updateActionTargetStatus

        public void updateActionTargetStatus​(String userId,
                                     String actionTargetGUID,
                                     GovernanceActionStatus status,
                                     Date startDate,
                                     Date completionDate)
                              throws InvalidParameterException,
                                     UserNotAuthorizedException,
                                     PropertyServerException
        Update the status of a specific action target. By default, these values are derived from the values for the governance action service. However, if the governance action service has to process name target elements, then setting the status on each individual target will show the progress of the governance action service.
        Specified by:
        updateActionTargetStatus in interface GovernanceProcessingInterface
        Parameters:
        userId - caller's userId
        actionTargetGUID - unique identifier of the governance action service.
        status - status enum to show its progress
        startDate - date/time that the governance action service started processing the target
        completionDate - date/time that the governance process completed processing this target.
        Throws:
        InvalidParameterException - the action target GUID is not recognized
        UserNotAuthorizedException - the governance action service is not authorized to update the action target properties
        PropertyServerException - there is a problem connecting to the metadata store

      • initiateGovernanceAction

        public 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 originatorServiceName,
                                       String originatorEngineName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       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.
        Specified by:
        initiateGovernanceAction in interface GovernanceProcessingInterface
        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
        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:
        InvalidParameterException - null qualified name
        UserNotAuthorizedException - this governance action service is not authorized to create a governance action
        PropertyServerException - there is a problem with the metadata store

      • initiateGovernanceActionProcess

        public String initiateGovernanceActionProcess​(String userId,
                                              String processQualifiedName,
                                              List<String> requestSourceGUIDs,
                                              List<NewActionTarget> actionTargets,
                                              Date startTime,
                                              Map<String,​String> requestParameters,
                                              String originatorServiceName,
                                              String originatorEngineName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException
        Using the named governance action process as a template, initiate a chain of governance actions.
        Specified by:
        initiateGovernanceActionProcess in interface GovernanceProcessingInterface
        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 - list 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:
        InvalidParameterException - null or unrecognized qualified name of the process
        UserNotAuthorizedException - this governance action service is not authorized to create a governance action process
        PropertyServerException - there is a problem with the metadata store

      • createIncidentReport

        public String createIncidentReport​(String userId,
                                   String qualifiedName,
                                   int domainIdentifier,
                                   String background,
                                   List<IncidentImpactedElement> impactedResources,
                                   List<IncidentDependency> previousIncidents,
                                   Map<String,​Integer> incidentClassifiers,
                                   Map<String,​String> additionalProperties,
                                   String originatorGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Create an incident report to capture the situation detected by this governance action service. This incident report will be processed by other governance activities.
        Specified by:
        createIncidentReport in interface SpecialGovernanceActionInterface
        Parameters:
        userId - caller's userId
        qualifiedName - unique identifier to give this new incident report
        domainIdentifier - governance domain associated with this action (0=ALL)
        background - description of the situation
        impactedResources - details of the resources impacted by this situation
        previousIncidents - links to previous incident reports covering this situation
        incidentClassifiers - initial classifiers for the incident report
        additionalProperties - additional arbitrary properties for the incident reports
        originatorGUID - the unique identifier of the person or process that created the incident
        Returns:
        unique identifier of the resulting incident report
        Throws:
        InvalidParameterException - null or non-unique qualified name for the incident report
        UserNotAuthorizedException - this governance action service is not authorized to create an incident report
        PropertyServerException - there is a problem with the metadata store

      • linkElementsAsPeerDuplicates

        public void linkElementsAsPeerDuplicates​(String userId,
                                         String metadataElement1GUID,
                                         String metadataElement2GUID,
                                         int statusIdentifier,
                                         String steward,
                                         String stewardTypeName,
                                         String stewardPropertyName,
                                         String source,
                                         String notes,
                                         boolean setKnownDuplicate)
                                  throws InvalidParameterException,
                                         UserNotAuthorizedException,
                                         PropertyServerException
        Link elements as peer duplicates. Create a simple relationship between two elements. If the relationship already exists, the properties are updated.
        Specified by:
        linkElementsAsPeerDuplicates in interface SpecialGovernanceActionInterface
        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:
        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
        UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
        PropertyServerException - there is a problem with the metadata store

      • linkConsolidatedDuplicate

        public void linkConsolidatedDuplicate​(String userId,
                                      String consolidatedElementGUID,
                                      int statusIdentifier,
                                      String steward,
                                      String stewardTypeName,
                                      String stewardPropertyName,
                                      String source,
                                      String notes,
                                      List<String> sourceElementGUIDs)
                               throws InvalidParameterException,
                                      UserNotAuthorizedException,
                                      PropertyServerException
        Identify an element that acts as a consolidated version for a set of duplicate elements. (The consolidated element is created using createMetadataElement.)
        Specified by:
        linkConsolidatedDuplicate in interface SpecialGovernanceActionInterface
        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:
        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
        UserNotAuthorizedException - the governance action service is not authorized to create this type of relationship
        PropertyServerException - there is a problem with the metadata store