Class ProcessManagerClient
- java.lang.Object
-
- org.odpi.openmetadata.accessservices.itinfrastructure.client.AssetManagerClientBase
-
- org.odpi.openmetadata.accessservices.itinfrastructure.client.ProcessManagerClient
-
- All Implemented Interfaces:
DeploymentManagementInterface,ProcessManagerInterface,ServerPurposeManagerInterface
public class ProcessManagerClient extends AssetManagerClientBase implements ProcessManagerInterface
PlatformManagerClient supports the APIs to maintain software server platforms and their related objects.
-
-
Constructor Summary
Constructors Constructor Description ProcessManagerClient(String serverName, String serverPlatformURLRoot)Create a new client with no authentication embedded in the HTTP request.ProcessManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password)Create a new client that passes userId and password in each HTTP request.ProcessManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)Create a new client that passes userId and password in each HTTP request.ProcessManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize)Create a new client that is going to be used in an OMAG Server.ProcessManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)Create a new client with no authentication embedded in the HTTP request.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclearBusinessSignificant(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String elementGUID, Date effectiveTime)Remove the "BusinessSignificant" designation from the element.voidclearControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String controlFlowGUID, Date effectiveTime)Remove the control flow relationship between two elements.voidclearDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String dataFlowGUID, Date effectiveTime)Remove the data flow relationship between two elements.voidclearLineageMapping(String userId, String lineageMappingGUID, Date effectiveTime)Remove the lineage mapping between two elements.voidclearProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processCallGUID, Date effectiveTime)Remove the process call relationship.voidclearProcessParent(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String parentProcessGUID, String childProcessGUID, Date effectiveTime)Remove a parent-child relationship between two processes.StringcreateProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, ProcessStatus processStatus, ProcessProperties processProperties)Create a new metadata element to represent a process.StringcreateProcessFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties)Create a new metadata element to represent a process using an existing metadata element as a template.List<ProcessElement>findProcesses(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize)Retrieve the list of process metadata elements that contain the search string.ControlFlowElementgetControlFlow(String userId, String currentStepGUID, String nextStepGUID, String qualifiedName, Date effectiveTime)Retrieve the control flow relationship between two elements.List<ControlFlowElement>getControlFlowNextSteps(String userId, String currentStepGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the control relationships linked from a specific element to the possible next elements in the process.List<ControlFlowElement>getControlFlowPreviousSteps(String userId, String currentStepGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the control relationships linked from a specific element to the possible previous elements in the process.DataFlowElementgetDataFlow(String userId, String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, Date effectiveTime)Retrieve the data flow relationship between two elements.List<DataFlowElement>getDataFlowConsumers(String userId, String dataSupplierGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the data flow relationships linked from a specific element to the downstream consumers.List<DataFlowElement>getDataFlowSuppliers(String userId, String dataConsumerGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the data flow relationships linked from a specific element to the upstream suppliers.List<LineageMappingElement>getDestinationLineageMappings(String userId, String sourceElementGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the lineage mapping relationships linked from a specific source element to its destinations.LineageMappingElementgetLineageMapping(String userId, String sourceElementGUID, String destinationElementGUID, String qualifiedName, Date effectiveTime)Retrieve the lineage mapping relationship between two elements.ProcessElementgetProcessByGUID(String userId, String processGUID)Retrieve the process metadata element with the supplied unique identifier.ProcessCallElementgetProcessCall(String userId, String callerGUID, String calledGUID, String qualifiedName, Date effectiveTime)Retrieve the process call relationship between two elements.List<ProcessCallElement>getProcessCalled(String userId, String callerGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the process call relationships linked from a specific element to the elements it calls.List<ProcessCallElement>getProcessCallers(String userId, String calledGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the process call relationships linked from a specific element to its callers.List<ProcessElement>getProcessesByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize)Retrieve the list of process metadata elements with a matching qualified or display name.List<ProcessElement>getProcessesForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize)Return the list of processes associated with the infrastructure manager.ProcessElementgetProcessParent(String userId, String processGUID, Date effectiveTime)Retrieve the process metadata element with the supplied unique identifier.List<LineageMappingElement>getSourceLineageMappings(String userId, String destinationElementGUID, int startFrom, int pageSize, Date effectiveTime)Retrieve the lineage mapping relationships linked from a specific destination element to its sources.List<ProcessElement>getSubProcesses(String userId, String processGUID, Date effectiveTime, int startFrom, int pageSize)Retrieve the process metadata element with the supplied unique identifier.voidpublishProcess(String userId, String processGUID)Update the zones for the asset so that it becomes visible to consumers.voidremoveProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID)Remove the metadata element representing a process.voidsetBusinessSignificant(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String elementGUID, Date effectiveFrom, Date effectiveTo)Classify a port, process or asset as "BusinessSignificant" (this may effect the way that lineage is displayed).StringsetupControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String currentStepGUID, String nextStepGUID, ControlFlowProperties properties, Date effectiveTime)Link two elements to show that when one completes the next is started.StringsetupDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String dataSupplierGUID, String dataConsumerGUID, DataFlowProperties properties, Date effectiveTime)Link two elements together to show that data flows from one to the other.StringsetupLineageMapping(String userId, String sourceElementGUID, String destinationElementGUID, LineageMappingProperties properties, Date effectiveTime)Link two elements together to show that they are part of the lineage of the data that is moving between the processes.StringsetupProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String callerGUID, String calledGUID, ProcessCallProperties properties, Date effectiveTime)Link two elements together to show a request-response call between them.voidsetupProcessParent(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String parentProcessGUID, String childProcessGUID, ProcessContainmentType containmentType, Date effectiveFrom, Date effectiveTo)Create a parent-child relationship between two processes.voidupdateControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String controlFlowGUID, ControlFlowProperties properties, Date effectiveTime)Update the relationship between two elements that shows that when one completes the next is started.voidupdateDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String dataFlowGUID, DataFlowProperties properties, Date effectiveTime)Update relationship between two elements that shows that data flows from one to the other.voidupdateLineageMapping(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String lineageMappingGUID, LineageMappingProperties properties, Date effectiveTime)Update the lineage mapping relationship between two elements.voidupdateProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID, boolean isMergeUpdate, ProcessProperties processProperties)Update the metadata element representing a process.voidupdateProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processCallGUID, ProcessCallProperties properties, Date effectiveTime)Update the relationship between two elements that shows a request-response call between them.voidupdateProcessStatus(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID, ProcessStatus processStatus)Update the status of the metadata element representing a process.voidwithdrawProcess(String userId, String processGUID)Update the zones for the asset so that it is no longer visible to consumers.-
Methods inherited from class org.odpi.openmetadata.accessservices.itinfrastructure.client.AssetManagerClientBase
addServerPurpose, clearDeployment, clearServerPurpose, deployITAsset, getDeployedITAssets, getDeploymentDestinations, updateITAssetDeployment, updateServerPurpose
-
-
-
-
Constructor Detail
-
ProcessManagerClient
public ProcessManagerClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog) 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 serversauditLog- logging destination- Throws:
InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
ProcessManagerClient
public ProcessManagerClient(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 toserverPlatformURLRoot- 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.
-
ProcessManagerClient
public ProcessManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password) 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 serversuserId- caller's userId embedded in all HTTP requestspassword- 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.
-
ProcessManagerClient
public ProcessManagerClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) 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 serversuserId- caller's userId embedded in all HTTP requestspassword- caller's userId embedded in all HTTP requestsauditLog- logging destination- Throws:
InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
ProcessManagerClient
public ProcessManagerClient(String serverName, String serverPlatformURLRoot, ITInfrastructureRESTClient restClient, int maxPageSize) throws InvalidParameterException
Create a new client that is going to be used in an OMAG Server.- Parameters:
serverName- name of the server to connect toserverPlatformURLRoot- the network address of the server running the OMAS REST serversrestClient- client that issues the REST API callsmaxPageSize- maximum number of results supported by this server- Throws:
InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Detail
-
createProcess
public String createProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, ProcessStatus processStatus, ProcessProperties processProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create a new metadata element to represent a process.- Specified by:
createProcessin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerinfrastructureManagerIsHome- ensure that only the infrastructure manager can update this processprocessStatus- initial status of the processprocessProperties- properties about the process to store- Returns:
- unique identifier of the new process
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
createProcessFromTemplate
public String createProcessFromTemplate(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create a new metadata element to represent a process using an existing metadata element as a template.- Specified by:
createProcessFromTemplatein interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerinfrastructureManagerIsHome- ensure that only the infrastructure manager can update this processtemplateGUID- unique identifier of the metadata element to copytemplateProperties- properties that override the template- Returns:
- unique identifier of the new process
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
updateProcess
public void updateProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID, boolean isMergeUpdate, ProcessProperties processProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the metadata element representing a process.- Specified by:
updateProcessin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerprocessGUID- unique identifier of the metadata element to updateisMergeUpdate- should the new properties be merged with existing properties (true) or completely replace them (false)?processProperties- new properties for the metadata element- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
updateProcessStatus
public void updateProcessStatus(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID, ProcessStatus processStatus) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the status of the metadata element representing a process.- Specified by:
updateProcessStatusin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerprocessGUID- unique identifier of the process to updateprocessStatus- new status for the process- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
setupProcessParent
public void setupProcessParent(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String parentProcessGUID, String childProcessGUID, ProcessContainmentType containmentType, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Create a parent-child relationship between two processes.- Specified by:
setupProcessParentin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerinfrastructureManagerIsHome- ensure that only the infrastructure manager can update this assetparentProcessGUID- unique identifier of the process in the external infrastructure manager that is to be the parent processchildProcessGUID- unique identifier of the process in the external infrastructure manager that is to be the nested sub-processcontainmentType- describes the ownership of the sub-processeffectiveFrom- time when this relationship is effective - null means immediatelyeffectiveTo- time when this relationship is no longer effective - null means forever- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
clearProcessParent
public void clearProcessParent(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String parentProcessGUID, String childProcessGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove a parent-child relationship between two processes.- Specified by:
clearProcessParentin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerparentProcessGUID- unique identifier of the process in the external infrastructure manager that is to be the parent processchildProcessGUID- unique identifier of the process in the external infrastructure manager that is to be the nested sub-processeffectiveTime- time when the relationship is effective- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
publishProcess
public void publishProcess(String userId, String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the zones for the asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the IT Infrastructure OMAS).- Specified by:
publishProcessin interfaceProcessManagerInterface- Parameters:
userId- calling userprocessGUID- unique identifier of the metadata element to publish- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
withdrawProcess
public void withdrawProcess(String userId, String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the zones for the asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the IT Infrastructure OMAS. This is the setting when the host is first created).- Specified by:
withdrawProcessin interfaceProcessManagerInterface- Parameters:
userId- calling userprocessGUID- unique identifier of the metadata element to withdraw- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
removeProcess
public void removeProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the metadata element representing a process.- Specified by:
removeProcessin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerprocessGUID- unique identifier of the metadata element to remove- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
findProcesses
public List<ProcessElement> findProcesses(String userId, String searchString, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the list of process metadata elements that contain the search string. The search string is treated as a regular expression.- Specified by:
findProcessesin interfaceProcessManagerInterface- Parameters:
userId- calling usersearchString- string to find in the propertieseffectiveTime- effective time for the querystartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessesByName
public List<ProcessElement> getProcessesByName(String userId, String name, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the list of process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.- Specified by:
getProcessesByNamein interfaceProcessManagerInterface- Parameters:
userId- calling username- name to search foreffectiveTime- effective time for the querystartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of matching metadata elements
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessesForInfrastructureManager
public List<ProcessElement> getProcessesForInfrastructureManager(String userId, String infrastructureManagerGUID, String infrastructureManagerName, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Return the list of processes associated with the infrastructure manager.- Specified by:
getProcessesForInfrastructureManagerin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callereffectiveTime- effective time for the querystartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of metadata elements describing the processes associated with the requested infrastructure manager
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessByGUID
public ProcessElement getProcessByGUID(String userId, String processGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the process metadata element with the supplied unique identifier.- Specified by:
getProcessByGUIDin interfaceProcessManagerInterface- Parameters:
userId- calling userprocessGUID- unique identifier of the requested metadata element- Returns:
- requested metadata element
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessParent
public ProcessElement getProcessParent(String userId, String processGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the process metadata element with the supplied unique identifier.- Specified by:
getProcessParentin interfaceProcessManagerInterface- Parameters:
userId- calling userprocessGUID- unique identifier of the requested metadata elementeffectiveTime- effective time for the query- Returns:
- parent process element
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getSubProcesses
public List<ProcessElement> getSubProcesses(String userId, String processGUID, Date effectiveTime, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the process metadata element with the supplied unique identifier.- Specified by:
getSubProcessesin interfaceProcessManagerInterface- Parameters:
userId- calling userprocessGUID- unique identifier of the requested metadata elementeffectiveTime- effective time for the querystartFrom- paging start pointpageSize- maximum results that can be returned- Returns:
- list of process element
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
setBusinessSignificant
public void setBusinessSignificant(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String elementGUID, Date effectiveFrom, Date effectiveTo) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Classify a port, process or asset as "BusinessSignificant" (this may effect the way that lineage is displayed).- Specified by:
setBusinessSignificantin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerelementGUID- unique identifier of the metadata element to updateeffectiveFrom- time when this hosting is effective - null means immediatelyeffectiveTo- time when this hosting is no longer effective - null means forever- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
clearBusinessSignificant
public void clearBusinessSignificant(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String elementGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the "BusinessSignificant" designation from the element.- Specified by:
clearBusinessSignificantin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callereffectiveTime- effective time for the queryelementGUID- unique identifier of the metadata element to update- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
setupDataFlow
public String setupDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String dataSupplierGUID, String dataConsumerGUID, DataFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Link two elements together to show that data flows from one to the other.- Specified by:
setupDataFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerinfrastructureManagerIsHome- ensure that only the infrastructure manager can update this assetdataSupplierGUID- unique identifier of the data supplierdataConsumerGUID- unique identifier of the data consumerproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Returns:
- unique identifier of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getDataFlow
public DataFlowElement getDataFlow(String userId, String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the data flow relationship between two elements. The qualifiedName is optional unless there is more than one data flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.- Specified by:
getDataFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userdataSupplierGUID- unique identifier of the data supplierdataConsumerGUID- unique identifier of the data consumerqualifiedName- unique identifier for this relationshipeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
updateDataFlow
public void updateDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String dataFlowGUID, DataFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update relationship between two elements that shows that data flows from one to the other.- Specified by:
updateDataFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerdataFlowGUID- unique identifier of the data flow relationshipproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
clearDataFlow
public void clearDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String dataFlowGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the data flow relationship between two elements.- Specified by:
clearDataFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerdataFlowGUID- unique identifier of the data flow relationshipeffectiveTime- time when the relationship is effective- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getDataFlowConsumers
public List<DataFlowElement> getDataFlowConsumers(String userId, String dataSupplierGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the data flow relationships linked from a specific element to the downstream consumers.- Specified by:
getDataFlowConsumersin interfaceProcessManagerInterface- Parameters:
userId- calling userdataSupplierGUID- unique identifier of the data supplierstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getDataFlowSuppliers
public List<DataFlowElement> getDataFlowSuppliers(String userId, String dataConsumerGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the data flow relationships linked from a specific element to the upstream suppliers.- Specified by:
getDataFlowSuppliersin interfaceProcessManagerInterface- Parameters:
userId- calling userdataConsumerGUID- unique identifier of the data consumerstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
setupControlFlow
public String setupControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String currentStepGUID, String nextStepGUID, ControlFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Link two elements to show that when one completes the next is started.- Specified by:
setupControlFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerinfrastructureManagerIsHome- ensure that only the infrastructure manager can update this assetcurrentStepGUID- unique identifier of the previous stepnextStepGUID- unique identifier of the next stepproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Returns:
- unique identifier for the control flow relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getControlFlow
public ControlFlowElement getControlFlow(String userId, String currentStepGUID, String nextStepGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the control flow relationship between two elements. The qualifiedName is optional unless there is more than one control flow relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.- Specified by:
getControlFlowin interfaceProcessManagerInterface- Parameters:
userId- calling usercurrentStepGUID- unique identifier of the previous stepnextStepGUID- unique identifier of the next stepqualifiedName- unique identifier for this relationshipeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
updateControlFlow
public void updateControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String controlFlowGUID, ControlFlowProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the relationship between two elements that shows that when one completes the next is started.- Specified by:
updateControlFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callercontrolFlowGUID- unique identifier of the control flow relationshipproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
clearControlFlow
public void clearControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String controlFlowGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the control flow relationship between two elements.- Specified by:
clearControlFlowin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callercontrolFlowGUID- unique identifier of the control flow relationshipeffectiveTime- time when the relationship is effective- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getControlFlowNextSteps
public List<ControlFlowElement> getControlFlowNextSteps(String userId, String currentStepGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the control relationships linked from a specific element to the possible next elements in the process.- Specified by:
getControlFlowNextStepsin interfaceProcessManagerInterface- Parameters:
userId- calling usercurrentStepGUID- unique identifier of the current stepstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getControlFlowPreviousSteps
public List<ControlFlowElement> getControlFlowPreviousSteps(String userId, String currentStepGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the control relationships linked from a specific element to the possible previous elements in the process.- Specified by:
getControlFlowPreviousStepsin interfaceProcessManagerInterface- Parameters:
userId- calling usercurrentStepGUID- unique identifier of the current stepstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
setupProcessCall
public String setupProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String callerGUID, String calledGUID, ProcessCallProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Link two elements together to show a request-response call between them.- Specified by:
setupProcessCallin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerinfrastructureManagerIsHome- ensure that only the infrastructure manager can update this assetcallerGUID- unique identifier of the element that is making the callcalledGUID- unique identifier of the element that is processing the callproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Returns:
- unique identifier of the new relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessCall
public ProcessCallElement getProcessCall(String userId, String callerGUID, String calledGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the process call relationship between two elements. The qualifiedName is optional unless there is more than one process call relationships between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.- Specified by:
getProcessCallin interfaceProcessManagerInterface- Parameters:
userId- calling usercallerGUID- unique identifier of the element that is making the callcalledGUID- unique identifier of the element that is processing the callqualifiedName- unique identifier for this relationshipeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
updateProcessCall
public void updateProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processCallGUID, ProcessCallProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the relationship between two elements that shows a request-response call between them.- Specified by:
updateProcessCallin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerprocessCallGUID- unique identifier of the process call relationshipproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
clearProcessCall
public void clearProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processCallGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the process call relationship.- Specified by:
clearProcessCallin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerprocessCallGUID- unique identifier of the process call relationshipeffectiveTime- optional date for effective time of the query. Null means any effective time- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessCalled
public List<ProcessCallElement> getProcessCalled(String userId, String callerGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the process call relationships linked from a specific element to the elements it calls.- Specified by:
getProcessCalledin interfaceProcessManagerInterface- Parameters:
userId- calling usercallerGUID- unique identifier of the element that is making the callstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getProcessCallers
public List<ProcessCallElement> getProcessCallers(String userId, String calledGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the process call relationships linked from a specific element to its callers.- Specified by:
getProcessCallersin interfaceProcessManagerInterface- Parameters:
userId- calling usercalledGUID- unique identifier of the element that is processing the callstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
setupLineageMapping
public String setupLineageMapping(String userId, String sourceElementGUID, String destinationElementGUID, LineageMappingProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Link two elements together to show that they are part of the lineage of the data that is moving between the processes. Typically, the lineage relationships stitch together processes and data assets supported by different technologies.- Specified by:
setupLineageMappingin interfaceProcessManagerInterface- Parameters:
userId- calling usersourceElementGUID- unique identifier of the sourcedestinationElementGUID- unique identifier of the destinationproperties- unique identifier for this relationship along with description and/or additional relevant propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Returns:
- unique identifier of the new relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getLineageMapping
public LineageMappingElement getLineageMapping(String userId, String sourceElementGUID, String destinationElementGUID, String qualifiedName, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the lineage mapping relationship between two elements. The qualifiedName is optional unless there is more than one lineage mapping relationship between these two elements since it is used to disambiguate the request. This is often used in conjunction with update.- Specified by:
getLineageMappingin interfaceProcessManagerInterface- Parameters:
userId- calling usersourceElementGUID- unique identifier of the sourcedestinationElementGUID- unique identifier of the destinationqualifiedName- unique identifier for this relationshipeffectiveTime- effective time for the query- Returns:
- unique identifier and properties of the relationship
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
updateLineageMapping
public void updateLineageMapping(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String lineageMappingGUID, LineageMappingProperties properties, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Update the lineage mapping relationship between two elements.- Specified by:
updateLineageMappingin interfaceProcessManagerInterface- Parameters:
userId- calling userinfrastructureManagerGUID- unique identifier of software server capability representing the callerinfrastructureManagerName- unique name of software server capability representing the callerlineageMappingGUID- unique identifier of the relationshipproperties- qualified name for this relationship and other related propertieseffectiveTime- optional date for effective time of the query. Null means any effective time- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
clearLineageMapping
public void clearLineageMapping(String userId, String lineageMappingGUID, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Remove the lineage mapping between two elements.- Specified by:
clearLineageMappingin interfaceProcessManagerInterface- Parameters:
userId- calling userlineageMappingGUID- unique identifier of the relationshipeffectiveTime- time when the relationship is effective- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getDestinationLineageMappings
public List<LineageMappingElement> getDestinationLineageMappings(String userId, String sourceElementGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the lineage mapping relationships linked from a specific source element to its destinations.- Specified by:
getDestinationLineageMappingsin interfaceProcessManagerInterface- Parameters:
userId- calling usersourceElementGUID- unique identifier of the sourcestartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- list of lineage mapping relationships
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
getSourceLineageMappings
public List<LineageMappingElement> getSourceLineageMappings(String userId, String destinationElementGUID, int startFrom, int pageSize, Date effectiveTime) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
Retrieve the lineage mapping relationships linked from a specific destination element to its sources.- Specified by:
getSourceLineageMappingsin interfaceProcessManagerInterface- Parameters:
userId- calling userdestinationElementGUID- unique identifier of the destinationstartFrom- paging start pointpageSize- maximum results that can be returnedeffectiveTime- time when the hosting is effective- Returns:
- list of lineage mapping relationships
- Throws:
InvalidParameterException- one of the parameters is invalidUserNotAuthorizedException- the user is not authorized to issue this requestPropertyServerException- there is a problem reported in the open metadata server(s)
-
-