Class StewardshipAction
java.lang.Object
org.odpi.openmetadata.accessservices.stewardshipaction.client.StewardshipAction
- All Implemented Interfaces:
DuplicateManagementInterface
,SurveyReportInterface
public class StewardshipAction
extends Object
implements SurveyReportInterface, DuplicateManagementInterface
StewardshipAction provides the generic client-side interface for the Stewardship Action Open Metadata Access Service (OMAS).
This client is initialized with the URL and name of the server that is running the Stewardship Action OMAS.
-
Constructor Summary
ConstructorDescriptionStewardshipAction
(String serverName, String serverPlatformURLRoot, int maxPageSize) Create a new client with no authentication embedded in the HTTP request.StewardshipAction
(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize) Create a new client that passes userId and password in each HTTP request.StewardshipAction
(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, int maxPageSize) Create a new client that passes userId and password in each HTTP request.StewardshipAction
(String serverName, String serverPlatformURLRoot, StewardshipActionRESTClient restClient, int maxPageSize, AuditLog auditLog) Create a new client that is going to be used in an OMAG Server (view service, engine service or integration service typically).StewardshipAction
(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize) Create a new client with no authentication embedded in the HTTP request. -
Method Summary
Modifier and TypeMethodDescriptiongetConsolidatedDuplicate
(String userId, String elementGUID) Return details of the consolidated duplicate for a requested element.getContributingDuplicates
(String userId, String consolidatedDuplicateGUID, int startFrom, int pageSize) List the elements that are contributing to a consolidating duplicate element.getExtendedAnnotations
(String userId, String annotationGUID, int startFrom, int pageSize) Return any annotations attached to this annotation.getPeerDuplicates
(String userId, String elementGUID, int startFrom, int pageSize) List the elements that are linked as peer duplicates to the requested element.getSurveyReportAnnotations
(String userId, String reportGUID, int startFrom, int pageSize) Return the annotations linked directly to the report.getSurveyReports
(String userId, String assetGUID, int startFrom, int pageSize) Return the survey reports linked to the asset.void
linkElementsAsDuplicates
(String userId, String element1GUID, String element2GUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes) Create a simple relationship between two elements.void
linkElementToConsolidatedDuplicate
(String userId, String consolidatedDuplicateGUID, String contributingElementGUID) Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.void
markAsConsolidatedDuplicate
(String userId, String consolidatedDuplicateGUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes) Mark an element as a consolidated duplicate (or update the properties if it is already marked as such).void
markElementAsKnownDuplicate
(String userId, String elementGUID) Classify an element as a known duplicate.void
removeConsolidatedDuplicate
(String userId, String consolidatedDuplicateGUID) Remove the consolidated duplicate element and the links to the elements that contributed to its values.void
unlinkElementFromConsolidatedDuplicate
(String userId, String consolidatedDuplicateGUID, String contributingElementGUID) Remove the relationship between two elements that marks them as duplicates.void
unlinkElementsAsDuplicates
(String userId, String element1GUID, String element2GUID) Remove the relationship between two elements that marks them as duplicates.void
unmarkElementAsKnownDuplicate
(String userId, String elementGUID) Remove the classification that identifies this element as a known duplicate.
-
Constructor Details
-
StewardshipAction
public StewardshipAction(String serverName, String serverPlatformURLRoot, AuditLog auditLog, int maxPageSize) throws InvalidParameterException Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesauditLog
- logging destinationmaxPageSize
- maximum value allowed for page size- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
StewardshipAction
public StewardshipAction(String serverName, String serverPlatformURLRoot, int maxPageSize) throws InvalidParameterException Create a new client with no authentication embedded in the HTTP request.- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesmaxPageSize
- maximum value allowed for page size- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
StewardshipAction
public StewardshipAction(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog, 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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requestsauditLog
- logging destinationmaxPageSize
- maximum value allowed for page size- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
StewardshipAction
public StewardshipAction(String serverName, String serverPlatformURLRoot, String userId, String password, 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 toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesuserId
- caller's userId embedded in all HTTP requestspassword
- caller's userId embedded in all HTTP requestsmaxPageSize
- maximum value allowed for page size- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
StewardshipAction
public StewardshipAction(String serverName, String serverPlatformURLRoot, StewardshipActionRESTClient restClient, int maxPageSize, AuditLog auditLog) throws InvalidParameterException Create a new client that is going to be used in an OMAG Server (view service, engine service or integration service typically).- Parameters:
serverName
- name of the server to connect toserverPlatformURLRoot
- the network address of the server running the OMAS REST servicesrestClient
- client that issues the REST API callsmaxPageSize
- maximum number of results supported by this serverauditLog
- logging destination- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Details
-
getSurveyReports
public List<SurveyReport> getSurveyReports(String userId, String assetGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the survey reports linked to the asset.- Specified by:
getSurveyReports
in interfaceSurveyReportInterface
- Parameters:
userId
- calling userassetGUID
- unique identifier of the assetstartFrom
- position in the list (used when there are so many reports that paging is needed)pageSize
- maximum number of elements to return an this call- Returns:
- list of discovery analysis reports
- Throws:
InvalidParameterException
- one of the parameters is null or invalid.UserNotAuthorizedException
- user not authorized to issue this request.PropertyServerException
- there was a problem that occurred within the property server.
-
getSurveyReportAnnotations
public List<Annotation> getSurveyReportAnnotations(String userId, String reportGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return the annotations linked directly to the report.- Specified by:
getSurveyReportAnnotations
in interfaceSurveyReportInterface
- Parameters:
userId
- identifier of calling userreportGUID
- identifier of the discovery request.startFrom
- initial position in the stored list.pageSize
- maximum number of definitions to return on this call.- Returns:
- list of annotations
- Throws:
InvalidParameterException
- one of the parameters is null or invalid.UserNotAuthorizedException
- user not authorized to issue this request.PropertyServerException
- there was a problem that occurred within the property server.
-
getExtendedAnnotations
public List<Annotation> getExtendedAnnotations(String userId, String annotationGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return any annotations attached to this annotation.- Specified by:
getExtendedAnnotations
in interfaceSurveyReportInterface
- Parameters:
userId
- identifier of calling userannotationGUID
- anchor annotationstartFrom
- starting position in the listpageSize
- maximum number of annotations that can be returned.- Returns:
- list of Annotation objects
- Throws:
InvalidParameterException
- one of the parameters is null or invalid.UserNotAuthorizedException
- user not authorized to issue this request.PropertyServerException
- there was a problem that occurred within the property server.
-
linkElementsAsDuplicates
public void linkElementsAsDuplicates(String userId, String element1GUID, String element2GUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a simple relationship between two elements. These elements must be of the same type. If the relationship already exists, the properties are updated.- Specified by:
linkElementsAsDuplicates
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userelement1GUID
- unique identifier of first elementelement2GUID
- unique identifier of second elementstatusIdentifier
- what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)steward
- identifier of the stewardstewardTypeName
- type of element used to identify the stewardstewardPropertyName
- property name used to identify stewardsource
- source of the duplicate detection processingnotes
- notes for the steward- Throws:
InvalidParameterException
- one of the parameters is null or invalid, or the elements are of different typesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
unlinkElementsAsDuplicates
public void unlinkElementsAsDuplicates(String userId, String element1GUID, String element2GUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the relationship between two elements that marks them as duplicates.- Specified by:
unlinkElementsAsDuplicates
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userelement1GUID
- unique identifier of first elementelement2GUID
- unique identifier of second element- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
markElementAsKnownDuplicate
public void markElementAsKnownDuplicate(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Classify an element as a known duplicate. This will mean that it is included in duplicate processing during metadata retrieval requests.- Specified by:
markElementAsKnownDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userelementGUID
- unique identifier of the element- Throws:
InvalidParameterException
- one of the parameters is null or invalid, or the elements are of different typesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
unmarkElementAsKnownDuplicate
public void unmarkElementAsKnownDuplicate(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the classification that identifies this element as a known duplicate.- Specified by:
unmarkElementAsKnownDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userelementGUID
- unique identifier of the element- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getPeerDuplicates
public List<DuplicateElement> getPeerDuplicates(String userId, String elementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException List the elements that are linked as peer duplicates to the requested element.- Specified by:
getPeerDuplicates
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userelementGUID
- element to querystartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of linked duplicates
- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
markAsConsolidatedDuplicate
public void markAsConsolidatedDuplicate(String userId, String consolidatedDuplicateGUID, int statusIdentifier, String steward, String stewardTypeName, String stewardPropertyName, String source, String notes) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Mark an element as a consolidated duplicate (or update the properties if it is already marked as such). This method assumes that a standard create method has been used to create the element first using the values from contributing elements. It is just adding the ConsolidatedDuplicate classification to the element.- Specified by:
markAsConsolidatedDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userconsolidatedDuplicateGUID
- unique identifier of the element that contains the consolidated information from a collection of elements that are all duplicates of one another.statusIdentifier
- what is the status of this relationship (negative means untrusted, 0 means unverified and positive means trusted)steward
- identifier of the stewardstewardTypeName
- type of element used to identify the stewardstewardPropertyName
- property name used to identify stewardsource
- source of the duplicate detection processingnotes
- notes for the steward- Throws:
InvalidParameterException
- one of the parameters is null or invalidPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
linkElementToConsolidatedDuplicate
public void linkElementToConsolidatedDuplicate(String userId, String consolidatedDuplicateGUID, String contributingElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Create a ConsolidatedDuplicateLink relationship between the consolidated duplicate element and one of its contributing element.- Specified by:
linkElementToConsolidatedDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userconsolidatedDuplicateGUID
- unique identifier of consolidated duplicatecontributingElementGUID
- unique identifier of duplicate element- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
unlinkElementFromConsolidatedDuplicate
public void unlinkElementFromConsolidatedDuplicate(String userId, String consolidatedDuplicateGUID, String contributingElementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the relationship between two elements that marks them as duplicates.- Specified by:
unlinkElementFromConsolidatedDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userconsolidatedDuplicateGUID
- unique identifier of consolidated duplicatecontributingElementGUID
- unique identifier of duplicate element- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getContributingDuplicates
public List<ElementStub> getContributingDuplicates(String userId, String consolidatedDuplicateGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException List the elements that are contributing to a consolidating duplicate element.- Specified by:
getContributingDuplicates
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userconsolidatedDuplicateGUID
- element to querystartFrom
- paging start pointpageSize
- maximum results that can be returned- Returns:
- list of contributing duplicates
- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
getConsolidatedDuplicate
public ElementStub getConsolidatedDuplicate(String userId, String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Return details of the consolidated duplicate for a requested element.- Specified by:
getConsolidatedDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userelementGUID
- element to query- Returns:
- header of consolidated duplicated or null if none
- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-
removeConsolidatedDuplicate
public void removeConsolidatedDuplicate(String userId, String consolidatedDuplicateGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Remove the consolidated duplicate element and the links to the elements that contributed to its values.- Specified by:
removeConsolidatedDuplicate
in interfaceDuplicateManagementInterface
- Parameters:
userId
- calling userconsolidatedDuplicateGUID
- unique identifier of element to remove- Throws:
InvalidParameterException
- one of the parameters is null or invalid or the elements are not linked as duplicatesPropertyServerException
- problem accessing property serverUserNotAuthorizedException
- security access problem
-