Package org.odpi.openmetadata.accessservices.itinfrastructure.client

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

Modifier and Type	Method	Description
void	clearBusinessSignificant(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String elementGUID, Date effectiveTime)	Remove the "BusinessSignificant" designation from the element.
void	clearControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String controlFlowGUID, Date effectiveTime)	Remove the control flow relationship between two elements.
void	clearDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String dataFlowGUID, Date effectiveTime)	Remove the data flow relationship between two elements.
void	clearLineageMapping(String userId, String sourceElementGUID, String destinationElementGUID, Date effectiveTime)	Remove the lineage mapping between two elements.
void	clearProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processCallGUID, Date effectiveTime)	Remove the process call relationship.
void	clearProcessParent(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String parentProcessGUID, String childProcessGUID, Date effectiveTime)	Remove a parent-child relationship between two processes.
String	createProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, ProcessStatus processStatus, ProcessProperties processProperties)	Create a new metadata element to represent a process.
String	createProcessFromTemplate(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.
ControlFlowElement	getControlFlow(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, Date effectiveTime)	Retrieve the control relationships linked from an specific element to the possible next elements in the process.
List<ControlFlowElement>	getControlFlowPreviousSteps(String userId, String currentStepGUID, Date effectiveTime)	Retrieve the control relationships linked from an specific element to the possible previous elements in the process.
DataFlowElement	getDataFlow(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, Date effectiveTime)	Retrieve the data flow relationships linked from an specific element to the downstream consumers.
List<DataFlowElement>	getDataFlowSuppliers(String userId, String dataConsumerGUID, Date effectiveTime)	Retrieve the data flow relationships linked from an specific element to the upstream suppliers.
List<LineageMappingElement>	getDestinationLineageMappings(String userId, String sourceElementGUID, Date effectiveTime)	Retrieve the lineage mapping relationships linked from an specific source element to its destinations.
ProcessElement	getProcessByGUID(String userId, String processGUID)	Retrieve the process metadata element with the supplied unique identifier.
ProcessCallElement	getProcessCall(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, Date effectiveTime)	Retrieve the process call relationships linked from an specific element to the elements it calls.
List<ProcessCallElement>	getProcessCallers(String userId, String calledGUID, Date effectiveTime)	Retrieve the process call relationships linked from an 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.
ProcessElement	getProcessParent(String userId, String processGUID, Date effectiveTime)	Retrieve the process metadata element with the supplied unique identifier.
List<LineageMappingElement>	getSourceLineageMappings(String userId, String destinationElementGUID, Date effectiveTime)	Retrieve the lineage mapping relationships linked from an 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.
void	publishProcess(String userId, String processGUID)	Update the zones for the asset so that it becomes visible to consumers.
void	removeProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID)	Remove the metadata element representing a process.
void	setBusinessSignificant(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).
String	setupControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String currentStepGUID, String nextStepGUID, String qualifiedName, String description, String guard, Date effectiveFrom, Date effectiveTo)	Link two elements to show that when one completes the next is started.
String	setupDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String dataSupplierGUID, String dataConsumerGUID, String qualifiedName, String description, String formula, Date effectiveFrom, Date effectiveTo)	Link two elements together to show that data flows from one to the other.
String	setupLineageMapping(String userId, String sourceElementGUID, String destinationElementGUID, Date effectiveFrom, Date effectiveTo)	Link two elements together to show that they are part of the lineage of the data that is moving between the processes.
String	setupProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, boolean infrastructureManagerIsHome, String callerGUID, String calledGUID, String qualifiedName, String description, String formula, Date effectiveFrom, Date effectiveTo)	Link two elements together to show a request-response call between them.
void	setupProcessParent(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.
void	updateControlFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String controlFlowGUID, String qualifiedName, String description, String guard, Date effectiveFrom, Date effectiveTo)	Update the relationship between two elements that shows that when one completes the next is started.
void	updateDataFlow(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String dataFlowGUID, String qualifiedName, String description, String formula, Date effectiveFrom, Date effectiveTo)	Update relationship between two elements that shows that data flows from one to the other.
void	updateProcess(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID, boolean isMergeUpdate, ProcessProperties processProperties)	Update the metadata element representing a process.
void	updateProcessCall(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processCallGUID, String qualifiedName, String description, String formula, Date effectiveFrom, Date effectiveTo)	Update the relationship between two elements that shows a request-response call between them.
void	updateProcessStatus(String userId, String infrastructureManagerGUID, String infrastructureManagerName, String processGUID, ProcessStatus processStatus)	Update the status of the metadata element representing a process.
void	withdrawProcess(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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 to

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

auditLog - 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 to

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

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

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 to

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

userId - caller's userId embedded in all HTTP requests

password - 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 to

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

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - 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 to

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

restClient - client that issues the REST API calls

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

createProcess in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this process

processStatus - initial status of the process

processProperties - properties about the process to store

Returns:

unique identifier of the new process

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

createProcessFromTemplate in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this process

templateGUID - unique identifier of the metadata element to copy

templateProperties - properties that override the template

Returns:

unique identifier of the new process

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

updateProcess in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the metadata element to update

isMergeUpdate - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

updateProcessStatus in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the process to update

processStatus - new status for the process

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

setupProcessParent in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

parentProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the parent process

childProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the nested sub-process

containmentType - describes the ownership of the sub-process

effectiveFrom - time when this relationship is effective - null means immediately

effectiveTo - time when this relationship is no longer effective - null means forever

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

clearProcessParent in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

parentProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the parent process

childProcessGUID - unique identifier of the process in the external infrastructure manager that is to be the nested sub-process

effectiveTime - time when the relationship is effective

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

publishProcess in interface ProcessManagerInterface

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to publish

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

withdrawProcess in interface ProcessManagerInterface

Parameters:

userId - calling user

processGUID - unique identifier of the metadata element to withdraw

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

removeProcess in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

processGUID - unique identifier of the metadata element to remove

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

findProcesses in interface ProcessManagerInterface

Parameters:

userId - calling user

searchString - string to find in the properties

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getProcessesByName in interface ProcessManagerInterface

Parameters:

userId - calling user

name - name to search for

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getProcessesForInfrastructureManager in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - 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 invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getProcessByGUID in interface ProcessManagerInterface

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

Returns:

requested metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getProcessParent in interface ProcessManagerInterface

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

effectiveTime - effective time for the query

Returns:

parent process element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getSubProcesses in interface ProcessManagerInterface

Parameters:

userId - calling user

processGUID - unique identifier of the requested metadata element

effectiveTime - effective time for the query

startFrom - paging start point

pageSize - maximum results that can be returned

Returns:

list of process element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

setBusinessSignificant in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

elementGUID - unique identifier of the metadata element to update

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

clearBusinessSignificant in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

effectiveTime - effective time for the query

elementGUID - unique identifier of the metadata element to update

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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,
                            String qualifiedName,
                            String description,
                            String formula,
                            Date effectiveFrom,
                            Date effectiveTo)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException

Link two elements together to show that data flows from one to the other.

Specified by:

setupDataFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

dataSupplierGUID - unique identifier of the data supplier

dataConsumerGUID - unique identifier of the data consumer

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that determines the subset of the data that flows

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Returns:

unique identifier of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getDataFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

dataSupplierGUID - unique identifier of the data supplier

dataConsumerGUID - unique identifier of the data consumer

qualifiedName - unique identifier for this relationship

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateDataFlow

public void updateDataFlow(String userId,
                           String infrastructureManagerGUID,
                           String infrastructureManagerName,
                           String dataFlowGUID,
                           String qualifiedName,
                           String description,
                           String formula,
                           Date effectiveFrom,
                           Date effectiveTo)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Update relationship between two elements that shows that data flows from one to the other.

Specified by:

updateDataFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

dataFlowGUID - unique identifier of the data flow relationship

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that determines the subset of the data that flows

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

clearDataFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

dataFlowGUID - unique identifier of the data flow relationship

effectiveTime - time when the relationship is effective

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataFlowConsumers

public List<DataFlowElement> getDataFlowConsumers(String userId,
                                                  String dataSupplierGUID,
                                                  Date effectiveTime)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Retrieve the data flow relationships linked from an specific element to the downstream consumers.

Specified by:

getDataFlowConsumers in interface ProcessManagerInterface

Parameters:

userId - calling user

dataSupplierGUID - unique identifier of the data supplier

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDataFlowSuppliers

public List<DataFlowElement> getDataFlowSuppliers(String userId,
                                                  String dataConsumerGUID,
                                                  Date effectiveTime)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Retrieve the data flow relationships linked from an specific element to the upstream suppliers.

Specified by:

getDataFlowSuppliers in interface ProcessManagerInterface

Parameters:

userId - calling user

dataConsumerGUID - unique identifier of the data consumer

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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,
                               String qualifiedName,
                               String description,
                               String guard,
                               Date effectiveFrom,
                               Date effectiveTo)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Link two elements to show that when one completes the next is started.

Specified by:

setupControlFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

currentStepGUID - unique identifier of the previous step

nextStepGUID - unique identifier of the next step

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

guard - function that must be true to travel down this control flow

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Returns:

unique identifier for the control flow relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getControlFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

currentStepGUID - unique identifier of the previous step

nextStepGUID - unique identifier of the next step

qualifiedName - unique identifier for this relationship

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateControlFlow

public void updateControlFlow(String userId,
                              String infrastructureManagerGUID,
                              String infrastructureManagerName,
                              String controlFlowGUID,
                              String qualifiedName,
                              String description,
                              String guard,
                              Date effectiveFrom,
                              Date effectiveTo)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Update the relationship between two elements that shows that when one completes the next is started.

Specified by:

updateControlFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

controlFlowGUID - unique identifier of the control flow relationship

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

guard - function that must be true to travel down this control flow

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

clearControlFlow in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

controlFlowGUID - unique identifier of the control flow relationship

effectiveTime - time when the relationship is effective

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getControlFlowNextSteps

public List<ControlFlowElement> getControlFlowNextSteps(String userId,
                                                        String currentStepGUID,
                                                        Date effectiveTime)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Retrieve the control relationships linked from an specific element to the possible next elements in the process.

Specified by:

getControlFlowNextSteps in interface ProcessManagerInterface

Parameters:

userId - calling user

currentStepGUID - unique identifier of the current step

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getControlFlowPreviousSteps

public List<ControlFlowElement> getControlFlowPreviousSteps(String userId,
                                                            String currentStepGUID,
                                                            Date effectiveTime)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the control relationships linked from an specific element to the possible previous elements in the process.

Specified by:

getControlFlowPreviousSteps in interface ProcessManagerInterface

Parameters:

userId - calling user

currentStepGUID - unique identifier of the current step

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - 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,
                               String qualifiedName,
                               String description,
                               String formula,
                               Date effectiveFrom,
                               Date effectiveTo)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Link two elements together to show a request-response call between them.

Specified by:

setupProcessCall in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset

callerGUID - unique identifier of the element that is making the call

calledGUID - unique identifier of the element that is processing the call

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that determines the subset of the data that flows

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

getProcessCall in interface ProcessManagerInterface

Parameters:

userId - calling user

callerGUID - unique identifier of the element that is making the call

calledGUID - unique identifier of the element that is processing the call

qualifiedName - unique identifier for this relationship

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateProcessCall

public void updateProcessCall(String userId,
                              String infrastructureManagerGUID,
                              String infrastructureManagerName,
                              String processCallGUID,
                              String qualifiedName,
                              String description,
                              String formula,
                              Date effectiveFrom,
                              Date effectiveTo)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException

Update the relationship between two elements that shows a request-response call between them.

Specified by:

updateProcessCall in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

processCallGUID - unique identifier of the process call relationship

qualifiedName - unique identifier for this relationship

description - description and/or purpose of the data flow

formula - function that determines the subset of the data that flows

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

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

clearProcessCall in interface ProcessManagerInterface

Parameters:

userId - calling user

infrastructureManagerGUID - unique identifier of software server capability representing the caller

infrastructureManagerName - unique name of software server capability representing the caller

processCallGUID - unique identifier of the process call relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getProcessCalled

public List<ProcessCallElement> getProcessCalled(String userId,
                                                 String callerGUID,
                                                 Date effectiveTime)
                                          throws InvalidParameterException,
                                                 UserNotAuthorizedException,
                                                 PropertyServerException

Retrieve the process call relationships linked from an specific element to the elements it calls.

Specified by:

getProcessCalled in interface ProcessManagerInterface

Parameters:

userId - calling user

callerGUID - unique identifier of the element that is making the call

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getProcessCallers

public List<ProcessCallElement> getProcessCallers(String userId,
                                                  String calledGUID,
                                                  Date effectiveTime)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Retrieve the process call relationships linked from an specific element to its callers.

Specified by:

getProcessCallers in interface ProcessManagerInterface

Parameters:

userId - calling user

calledGUID - unique identifier of the element that is processing the call

effectiveTime - time when the hosting is effective

Returns:

unique identifier and properties of the relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

setupLineageMapping

public String setupLineageMapping(String userId,
                                  String sourceElementGUID,
                                  String destinationElementGUID,
                                  Date effectiveFrom,
                                  Date effectiveTo)
                           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:

setupLineageMapping in interface ProcessManagerInterface

Parameters:

userId - calling user

sourceElementGUID - unique identifier of the source

destinationElementGUID - unique identifier of the destination

effectiveFrom - time when this hosting is effective - null means immediately

effectiveTo - time when this hosting is no longer effective - null means forever

Returns:

unique identifier of the new relationship

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

clearLineageMapping

public void clearLineageMapping(String userId,
                                String sourceElementGUID,
                                String destinationElementGUID,
                                Date effectiveTime)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Remove the lineage mapping between two elements.

Specified by:

clearLineageMapping in interface ProcessManagerInterface

Parameters:

userId - calling user

sourceElementGUID - unique identifier of the source

destinationElementGUID - unique identifier of the destination

effectiveTime - time when the relationship is effective

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getDestinationLineageMappings

public List<LineageMappingElement> getDestinationLineageMappings(String userId,
                                                                 String sourceElementGUID,
                                                                 Date effectiveTime)
                                                          throws InvalidParameterException,
                                                                 UserNotAuthorizedException,
                                                                 PropertyServerException

Retrieve the lineage mapping relationships linked from an specific source element to its destinations.

Specified by:

getDestinationLineageMappings in interface ProcessManagerInterface

Parameters:

userId - calling user

sourceElementGUID - unique identifier of the source

effectiveTime - time when the hosting is effective

Returns:

list of lineage mapping relationships

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getSourceLineageMappings

public List<LineageMappingElement> getSourceLineageMappings(String userId,
                                                            String destinationElementGUID,
                                                            Date effectiveTime)
                                                     throws InvalidParameterException,
                                                            UserNotAuthorizedException,
                                                            PropertyServerException

Retrieve the lineage mapping relationships linked from an specific destination element to its sources.

Specified by:

getSourceLineageMappings in interface ProcessManagerInterface

Parameters:

userId - calling user

destinationElementGUID - unique identifier of the destination

effectiveTime - time when the hosting is effective

Returns:

list of lineage mapping relationships

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)