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

Class OpenMetadataClient

java.lang.Object

org.odpi.openmetadata.frameworks.governanceaction.client.OpenMetadataClient

All Implemented Interfaces:

MetadataElementInterface, MultiLanguageInterface, StewardshipActionInterface, ValidMetadataValuesInterface

public abstract class OpenMetadataClient
extends Object
implements MetadataElementInterface, StewardshipActionInterface, MultiLanguageInterface, ValidMetadataValuesInterface

OpenMetadataClient provides access to metadata elements stored in the metadata repositories. It is implemented by a metadata repository provider. In Egeria, this class is implemented in the GAF Metadata Management running in the Metadata Access Server OMAG Server.

Constructor Summary

Constructors

Constructor	Description
OpenMetadataClient(String serviceURLMarker, String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
abstract void	classifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, ElementProperties properties, Date effectiveTime)	Add a new classification to the metadata element.
abstract 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)	Create an incident report to capture the situation detected by this governance action service.
abstract String	createMetadataElementInStore(String userId, String metadataElementTypeName, org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus initialStatus, Date effectiveFrom, Date effectiveTo, ElementProperties properties, String templateGUID)	Create a new metadata element in the metadata store.
abstract String	createRelatedElementsInStore(String userId, String relationshipTypeName, String metadataElement1GUID, String metadataElement2GUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, ElementProperties properties, Date effectiveTime)	Create a relationship between two metadata elements.
abstract void	declassifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Remove the named classification from a specific metadata element.
abstract void	deleteMetadataElementInStore(String userId, String metadataElementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Delete a specific metadata element.
abstract void	deleteRelatedElementsInStore(String userId, String relationshipGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Delete a relationship between two metadata elements.
abstract List<OpenMetadataElement>	findMetadataElements(String userId, String metadataElementTypeName, List<String> metadataElementSubtypeName, SearchProperties searchProperties, List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus> limitResultsByStatus, SearchClassifications matchClassifications, String sequencingProperty, SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize)	Return a list of metadata elements that match the supplied criteria.
abstract List<OpenMetadataElement>	findMetadataElementsWithString(String userId, String searchString, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize)	Retrieve the metadata elements that contain the requested string.
abstract List<RelatedMetadataElements>	findRelationshipsBetweenMetadataElements(String userId, String relationshipTypeName, SearchProperties searchProperties, String sequencingProperty, SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize)	Return a list of relationships that match the requested conditions.
abstract OpenMetadataElement	getMetadataElementByGUID(String userId, String elementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Retrieve the metadata element using its unique identifier.
abstract OpenMetadataElement	getMetadataElementByUniqueName(String userId, String uniqueName, String uniquePropertyName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Retrieve the metadata element using its unique name (typically the qualified name).
abstract String	getMetadataElementGUIDByUniqueName(String userId, String uniqueName, String uniquePropertyName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)	Retrieve the unique identifier of a metadata element using its unique name (typically the qualified name).
abstract List<RelatedMetadataElement>	getRelatedMetadataElements(String userId, String elementGUID, int startingAtEnd, String relationshipTypeName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize)	Retrieve the metadata elements connected to the supplied element.
abstract String	initiateGovernanceActionProcess(String userId, String processQualifiedName, List<String> requestSourceGUIDs, List<NewActionTarget> actionTargets, Date startTime, Map<String,String> requestParameters, String originatorServiceName, String originatorEngineName)	Using the named governance action process as a template, initiate a chain of governance actions.
abstract void	reclassifyMetadataElementInStore(String userId, String metadataElementGUID, String classificationName, boolean replaceProperties, boolean forLineage, boolean forDuplicateProcessing, ElementProperties properties, Date effectiveTime)	Update the properties of a classification that is currently attached to a specific metadata element.
String	toString()	Standard toString method.
abstract void	updateClassificationEffectivityInStore(String userId, String metadataElementGUID, String classificationName, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime)	Update the effectivity dates of a specific classification attached to a metadata element.
abstract void	updateMetadataElementEffectivityInStore(String userId, String metadataElementGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime)	Update the effectivity dates control the visibility of the element through specific APIs.
abstract void	updateMetadataElementInStore(String userId, String metadataElementGUID, boolean replaceProperties, boolean forLineage, boolean forDuplicateProcessing, ElementProperties properties, Date effectiveTime)	Update the properties of a specific metadata element.
abstract void	updateMetadataElementStatusInStore(String userId, String metadataElementGUID, boolean forLineage, boolean forDuplicateProcessing, org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus newElementStatus, Date effectiveTime)	Update the status of specific metadata element.
abstract void	updateRelatedElementsEffectivityInStore(String userId, String relationshipGUID, boolean forLineage, boolean forDuplicateProcessing, Date effectiveFrom, Date effectiveTo, Date effectiveTime)	Update the effectivity dates of a specific relationship between metadata elements.
abstract void	updateRelatedElementsInStore(String userId, String relationshipGUID, boolean replaceProperties, boolean forLineage, boolean forDuplicateProcessing, ElementProperties properties, Date effectiveTime)	Update the properties associated with a relationship.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.odpi.openmetadata.frameworks.governanceaction.client.MetadataElementInterface

classifyMetadataElementInStore, createMetadataElementInStore, createRelatedElementsInStore, declassifyMetadataElementInStore, deleteMetadataElementInStore, deleteRelatedElementsInStore, reclassifyMetadataElementInStore, updateClassificationEffectivityInStore, updateMetadataElementEffectivityInStore, updateMetadataElementInStore, updateMetadataElementStatusInStore, updateRelatedElementsEffectivityInStore, updateRelatedElementsInStore

Methods inherited from interface org.odpi.openmetadata.frameworks.governanceaction.client.MultiLanguageInterface

clearTranslation, getTranslation, getTranslations, setTranslation

Methods inherited from interface org.odpi.openmetadata.frameworks.governanceaction.client.StewardshipActionInterface

openToDo

Methods inherited from interface org.odpi.openmetadata.frameworks.governanceaction.client.ValidMetadataValuesInterface

clearValidMetadataMapName, clearValidMetadataMapValue, clearValidMetadataValue, getValidMetadataMapName, getValidMetadataMapValue, getValidMetadataValue, getValidMetadataValues, setUpValidMetadataMapName, setUpValidMetadataMapValue, setUpValidMetadataValue, validateMetadataMapName, validateMetadataMapValue, validateMetadataValue

Constructor Details

OpenMetadataClient

public OpenMetadataClient(String serviceURLMarker,
 String serverName,
 String serverPlatformURLRoot)

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serviceURLMarker - the identifier of the access service (for example asset-owner for the Asset Owner OMAS)

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

Method Details

getMetadataElementByGUID

public abstract OpenMetadataElement getMetadataElementByGUID(String userId,
 String elementGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the metadata element using its unique identifier.

Specified by:

getMetadataElementByGUID in interface MetadataElementInterface

Parameters:

userId - caller's userId

elementGUID - unique identifier for the metadata element

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or not known.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

getMetadataElementByUniqueName

public abstract OpenMetadataElement getMetadataElementByUniqueName(String userId,
 String uniqueName,
 String uniquePropertyName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                                            throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Retrieve the metadata element using its unique name (typically the qualified name).

Specified by:

getMetadataElementByUniqueName 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 properties or null if not found

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

getMetadataElementGUIDByUniqueName

public abstract String getMetadataElementGUIDByUniqueName(String userId,
 String uniqueName,
 String uniquePropertyName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                                   throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or not known.

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

findMetadataElementsWithString

public abstract List<OpenMetadataElement> findMetadataElementsWithString(String userId,
 String searchString,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the qualified name is null

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

getRelatedMetadataElements

public abstract List<RelatedMetadataElement> getRelatedMetadataElements(String userId,
 String elementGUID,
 int startingAtEnd,
 String relationshipTypeName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or not known; the relationship type is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the elements

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

findMetadataElements

public abstract List<OpenMetadataElement> findMetadataElements(String userId,
 String metadataElementTypeName,
 List<String> metadataElementSubtypeName,
 SearchProperties searchProperties,
 List<org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus> limitResultsByStatus,
 SearchClassifications matchClassifications,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                        throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the search parameters are is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the elements

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

findRelationshipsBetweenMetadataElements

public abstract List<RelatedMetadataElements> findRelationshipsBetweenMetadataElements(String userId,
 String relationshipTypeName,
 SearchProperties searchProperties,
 String sequencingProperty,
 SequencingOrder sequencingOrder,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime,
 int startFrom,
 int pageSize)
                                                                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the search parameters are is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not able to access the elements

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem accessing the metadata store

createMetadataElementInStore

public abstract String createMetadataElementInStore(String userId,
 String metadataElementTypeName,
 org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus initialStatus,
 Date effectiveFrom,
 Date effectiveTo,
 ElementProperties properties,
 String templateGUID)
                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the type name, status or one of the properties is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to create this type of element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

updateMetadataElementInStore

public abstract void updateMetadataElementInStore(String userId,
 String metadataElementGUID,
 boolean replaceProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 ElementProperties properties,
 Date effectiveTime)
                                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - either the unique identifier or the properties are invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

updateMetadataElementStatusInStore

public abstract void updateMetadataElementStatusInStore(String userId,
 String metadataElementGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 org.odpi.openmetadata.frameworks.connectors.properties.beans.ElementStatus newElementStatus,
 Date effectiveTime)
                                                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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.

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - either the unique identifier or the status are invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

updateMetadataElementEffectivityInStore

public abstract void updateMetadataElementEffectivityInStore(String userId,
 String metadataElementGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveFrom,
 Date effectiveTo,
 Date effectiveTime)
                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Update 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - either the unique identifier or the status are invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

deleteMetadataElementInStore

public abstract void deleteMetadataElementInStore(String userId,
 String metadataElementGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Delete a specific metadata element.

Specified by:

deleteMetadataElementInStore 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

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier is null or invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to delete this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

classifyMetadataElementInStore

public abstract void classifyMetadataElementInStore(String userId,
 String metadataElementGUID,
 String classificationName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveFrom,
 Date effectiveTo,
 ElementProperties properties,
 Date effectiveTime)
                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.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

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

reclassifyMetadataElementInStore

public abstract void reclassifyMetadataElementInStore(String userId,
 String metadataElementGUID,
 String classificationName,
 boolean replaceProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 ElementProperties properties,
 Date effectiveTime)
                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.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

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element/classification

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

updateClassificationEffectivityInStore

public abstract void updateClassificationEffectivityInStore(String userId,
 String metadataElementGUID,
 String classificationName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveFrom,
 Date effectiveTo,
 Date effectiveTime)
                                                     throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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

effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)

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

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - either the unique identifier or the status are invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

declassifyMetadataElementInStore

public abstract void declassifyMetadataElementInStore(String userId,
 String metadataElementGUID,
 String classificationName,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Remove the named classification from a specific metadata element.

Specified by:

declassifyMetadataElementInStore 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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier or classification name is null or invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to remove this classification

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

createRelatedElementsInStore

public abstract String createRelatedElementsInStore(String userId,
 String relationshipTypeName,
 String metadataElement1GUID,
 String metadataElement2GUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveFrom,
 Date effectiveTo,
 ElementProperties properties,
 Date effectiveTime)
                                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

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

updateRelatedElementsInStore

public abstract void updateRelatedElementsInStore(String userId,
 String relationshipGUID,
 boolean replaceProperties,
 boolean forLineage,
 boolean forDuplicateProcessing,
 ElementProperties properties,
 Date effectiveTime)
                                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier of the relationship is 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 update this relationship

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

updateRelatedElementsEffectivityInStore

public abstract void updateRelatedElementsEffectivityInStore(String userId,
 String relationshipGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveFrom,
 Date effectiveTo,
 Date effectiveTime)
                                                      throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - either the unique identifier or the status are invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to update this element

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

deleteRelatedElementsInStore

public abstract void deleteRelatedElementsInStore(String userId,
 String relationshipGUID,
 boolean forLineage,
 boolean forDuplicateProcessing,
 Date effectiveTime)
                                           throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Delete a relationship between two metadata elements.

Specified by:

deleteRelatedElementsInStore in interface MetadataElementInterface

Parameters:

userId - caller's userId

relationshipGUID - unique identifier of the relationship to delete

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the unique identifier of the relationship is null or invalid in some way

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the governance action service is not authorized to delete this relationship

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

initiateGovernanceActionProcess

public abstract 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

createIncidentReport

public abstract 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 org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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 StewardshipActionInterface

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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - null or non-unique qualified name for the incident report

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - this governance action service is not authorized to create a incident report

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem with the metadata store

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

Returns:

print out of variables in a JSON-style