org.odpi.openmetadata.accessservices.assetmanager.server

Class LineageExchangeRESTServices

java.lang.Object

org.odpi.openmetadata.accessservices.assetmanager.server.LineageExchangeRESTServices

public class LineageExchangeRESTServices
extends Object

LineageExchangeRESTServices is the server-side implementation of the Asset Manager OMAS's support for processes, ports and lineage mapping. It matches the LineageExchangeClient.

Constructor Summary

Constructors

Constructor and Description
LineageExchangeRESTServices() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	clearBusinessSignificant(String serverName, String userId, String elementGUID, MetadataCorrelationProperties requestBody) Remove the "BusinessSignificant" designation from the element.
VoidResponse	clearControlFlow(String serverName, String userId, String controlFlowGUID, AssetManagerIdentifiersRequestBody requestBody) Remove the control flow relationship between two elements.
VoidResponse	clearDataFlow(String serverName, String userId, String dataFlowGUID, AssetManagerIdentifiersRequestBody requestBody) Remove the data flow relationship between two elements.
VoidResponse	clearLineageMapping(String serverName, String userId, String sourceElementGUID, String destinationElementGUID, AssetManagerIdentifiersRequestBody requestBody) Remove the lineage mapping between two elements.
VoidResponse	clearPortDelegation(String serverName, String userId, String portOneGUID, String portTwoGUID, AssetManagerIdentifiersRequestBody requestBody) Remove the port delegation relationship between two ports.
VoidResponse	clearPortSchemaType(String serverName, String userId, String portGUID, String schemaTypeGUID, AssetManagerIdentifiersRequestBody requestBody) Remove the schema type from a port.
VoidResponse	clearProcessCall(String serverName, String userId, String processCallGUID, AssetManagerIdentifiersRequestBody requestBody) Remove the process call relationship.
VoidResponse	clearProcessParent(String serverName, String userId, String parentProcessGUID, String childProcessGUID, AssetManagerIdentifiersRequestBody requestBody) Remove a parent-child relationship between two processes.
VoidResponse	clearProcessPort(String serverName, String userId, String processGUID, String portGUID, AssetManagerIdentifiersRequestBody requestBody) Unlink a port from a process.
GUIDResponse	createPort(String serverName, String userId, boolean assetManagerIsHome, String processGUID, PortRequestBody requestBody) Create a new metadata element to represent a port.
GUIDResponse	createProcess(String serverName, String userId, boolean assetManagerIsHome, ProcessStatus initialStatus, ProcessRequestBody requestBody) Create a new metadata element to represent a process.
GUIDResponse	createProcessFromTemplate(String serverName, String userId, boolean assetManagerIsHome, String templateGUID, TemplateRequestBody requestBody) Create a new metadata element to represent a process using an existing metadata element as a template.
PortElementsResponse	findPorts(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of port metadata elements that contain the search string.
ProcessElementsResponse	findProcesses(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody) Retrieve the list of process metadata elements that contain the search string.
ControlFlowElementResponse	getControlFlow(String serverName, String userId, String currentStepGUID, String nextStepGUID, NameRequestBody requestBody) Retrieve the control flow relationship between two elements.
ControlFlowElementsResponse	getControlFlowNextSteps(String serverName, String userId, String currentStepGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the control relationships linked from an specific element to the possible next elements in the process.
ControlFlowElementsResponse	getControlFlowPreviousSteps(String serverName, String userId, String currentStepGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the control relationships linked from an specific element to the possible previous elements in the process.
DataFlowElementResponse	getDataFlow(String serverName, String userId, String dataSupplierGUID, String dataConsumerGUID, NameRequestBody requestBody) Retrieve the data flow relationship between two elements.
DataFlowElementsResponse	getDataFlowConsumers(String serverName, String userId, String dataSupplierGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the data flow relationships linked from an specific element to the downstream consumers.
DataFlowElementsResponse	getDataFlowSuppliers(String serverName, String userId, String dataConsumerGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the data flow relationships linked from an specific element to the upstream suppliers.
LineageMappingElementsResponse	getDestinationLineageMappings(String serverName, String userId, String sourceElementGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the lineage mapping relationships linked from an specific source element to its destinations.
PortElementResponse	getPortByGUID(String serverName, String userId, String portGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the port metadata element with the supplied unique identifier.
PortElementResponse	getPortDelegation(String serverName, String userId, String portGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the port that this port delegates to.
PortElementsResponse	getPortsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of port metadata elements with a matching qualified or display name.
PortElementsResponse	getPortsForProcess(String serverName, String userId, String processGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody) Retrieve the list of ports associated with a process.
PortElementsResponse	getPortUse(String serverName, String userId, String portGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody) Retrieve the list of ports that delegate to this port.
ProcessElementResponse	getProcessByGUID(String serverName, String userId, String processGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the process metadata element with the supplied unique identifier.
ProcessCallElementResponse	getProcessCall(String serverName, String userId, String callerGUID, String calledGUID, NameRequestBody requestBody) Retrieve the process call relationship between two elements.
ProcessCallElementsResponse	getProcessCalled(String serverName, String userId, String callerGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the process call relationships linked from an specific element to the elements it calls.
ProcessCallElementsResponse	getProcessCallers(String serverName, String userId, String calledGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the process call relationships linked from an specific element to its callers.
ProcessElementsResponse	getProcessesByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody) Retrieve the list of process metadata elements with a matching qualified or display name.
ProcessElementsResponse	getProcessesForAssetManager(String serverName, String userId, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody) Return the list of processes associated with the process manager.
ProcessElementResponse	getProcessParent(String serverName, String userId, String processGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the process metadata element with the supplied unique identifier.
LineageMappingElementsResponse	getSourceLineageMappings(String serverName, String userId, String destinationElementGUID, AssetManagerIdentifiersRequestBody requestBody) Retrieve the lineage mapping relationships linked from an specific destination element to its sources.
ProcessElementsResponse	getSubProcesses(String serverName, String userId, String processGUID, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody) Retrieve the process metadata element with the supplied unique identifier.
VoidResponse	publishProcess(String serverName, String userId, String processGUID, AssetManagerIdentifiersRequestBody requestBody) Update the zones for the process so that it becomes visible to consumers.
VoidResponse	removePort(String serverName, String userId, String portGUID, MetadataCorrelationProperties requestBody) Remove the metadata element representing a port.
VoidResponse	removeProcess(String serverName, String userId, String processGUID, MetadataCorrelationProperties requestBody) Remove the metadata element representing a process.
VoidResponse	setBusinessSignificant(String serverName, String userId, String elementGUID, MetadataCorrelationProperties requestBody) Classify a port, process or process as "BusinessSignificant" (this may effect the way that lineage is displayed).
GUIDResponse	setupControlFlow(String serverName, String userId, String currentStepGUID, String nextStepGUID, boolean assetManagerIsHome, ControlFlowRequestBody requestBody) Link two elements to show that when one completes the next is started.
GUIDResponse	setupDataFlow(String serverName, String userId, String dataSupplierGUID, String dataConsumerGUID, boolean assetManagerIsHome, DataFlowRequestBody requestBody) Link two elements together to show that data flows from one to the other.
VoidResponse	setupLineageMapping(String serverName, String userId, String sourceElementGUID, String destinationElementGUID, AssetManagerIdentifiersRequestBody requestBody) Link to elements together to show that they are part of the lineage of the data that is moving between the processes.
VoidResponse	setupPortDelegation(String serverName, String userId, boolean assetManagerIsHome, String portOneGUID, String portTwoGUID, AssetManagerIdentifiersRequestBody requestBody) Link two ports together to show that portTwo is an implementation of portOne.
VoidResponse	setupPortSchemaType(String serverName, String userId, boolean assetManagerIsHome, String portGUID, String schemaTypeGUID, AssetManagerIdentifiersRequestBody requestBody) Link a schema type to a port to show the structure of data it accepts.
GUIDResponse	setupProcessCall(String serverName, String userId, String callerGUID, String calledGUID, boolean assetManagerIsHome, ProcessCallRequestBody requestBody) Link two elements together to show a request-response call between them.
VoidResponse	setupProcessParent(String serverName, String userId, String parentProcessGUID, String childProcessGUID, boolean assetManagerIsHome, ProcessContainmentType containmentType, AssetManagerIdentifiersRequestBody requestBody) Create a parent-child relationship between two processes.
VoidResponse	setupProcessPort(String serverName, String userId, boolean assetManagerIsHome, String processGUID, String portGUID, AssetManagerIdentifiersRequestBody requestBody) Link a port to a process.
VoidResponse	updateControlFlow(String serverName, String userId, String controlFlowGUID, ControlFlowRequestBody requestBody) Update the relationship between two elements that shows that when one completes the next is started.
VoidResponse	updateDataFlow(String serverName, String userId, String dataFlowGUID, DataFlowRequestBody requestBody) Update relationship between two elements that shows that data flows from one to the other.
VoidResponse	updatePort(String serverName, String userId, String portGUID, PortRequestBody requestBody) Update the properties of the metadata element representing a port.
VoidResponse	updateProcess(String serverName, String userId, String processGUID, boolean isMergeUpdate, ProcessRequestBody requestBody) Update the metadata element representing a process.
VoidResponse	updateProcessCall(String serverName, String userId, String processCallGUID, ProcessCallRequestBody requestBody) Update the relationship between two elements that shows a request-response call between them.
VoidResponse	updateProcessStatus(String serverName, String userId, String processGUID, ProcessStatusRequestBody requestBody) Update the status of the metadata element representing a process.
VoidResponse	withdrawProcess(String serverName, String userId, String processGUID, AssetManagerIdentifiersRequestBody requestBody) Update the zones for the process so that it is no longer visible to consumers.

Methods inherited from class java.lang.Object

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

Constructor Detail

LineageExchangeRESTServices

public LineageExchangeRESTServices()

Default constructor

Method Detail

createProcess

public GUIDResponse createProcess(String serverName,
                                  String userId,
                                  boolean assetManagerIsHome,
                                  ProcessStatus initialStatus,
                                  ProcessRequestBody requestBody)

Create a new metadata element to represent a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the process manager can update this process

initialStatus - status value for the new process (default = ACTIVE)

requestBody - properties about the process to store

Returns:

unique identifier of the new process or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

createProcessFromTemplate

public GUIDResponse createProcessFromTemplate(String serverName,
                                              String userId,
                                              boolean assetManagerIsHome,
                                              String templateGUID,
                                              TemplateRequestBody requestBody)

Create a new metadata element to represent a process using an existing metadata element as a template.

Parameters:

serverName - name of the server to route the request to

userId - calling user

templateGUID - unique identifier of the metadata element to copy

assetManagerIsHome - ensure that only the process manager can update this process

requestBody - properties that override the template

Returns:

unique identifier of the new process or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

updateProcess

public VoidResponse updateProcess(String serverName,
                                  String userId,
                                  String processGUID,
                                  boolean isMergeUpdate,
                                  ProcessRequestBody requestBody)

Update the metadata element representing a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

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)?

requestBody - new properties for the metadata element

Returns:

void or 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 VoidResponse updateProcessStatus(String serverName,
                                        String userId,
                                        String processGUID,
                                        ProcessStatusRequestBody requestBody)

Update the status of the metadata element representing a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the process to update

requestBody - new status for the process

Returns:

void or 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 VoidResponse setupProcessParent(String serverName,
                                       String userId,
                                       String parentProcessGUID,
                                       String childProcessGUID,
                                       boolean assetManagerIsHome,
                                       ProcessContainmentType containmentType,
                                       AssetManagerIdentifiersRequestBody requestBody)

Create a parent-child relationship between two processes.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the process manager can update this process

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

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

containmentType - describes the ownership of the sub-process

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 VoidResponse clearProcessParent(String serverName,
                                       String userId,
                                       String parentProcessGUID,
                                       String childProcessGUID,
                                       AssetManagerIdentifiersRequestBody requestBody)

Remove a parent-child relationship between two processes.

Parameters:

serverName - name of the server to route the request to

userId - calling user

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

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

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 VoidResponse publishProcess(String serverName,
                                   String userId,
                                   String processGUID,
                                   AssetManagerIdentifiersRequestBody requestBody)

Update the zones for the process 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 Asset Manager OMAS).

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to publish

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 VoidResponse withdrawProcess(String serverName,
                                    String userId,
                                    String processGUID,
                                    AssetManagerIdentifiersRequestBody requestBody)

Update the zones for the process 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 Asset Manager OMAS. This is the setting when the process is first created).

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to withdraw

Returns:

void or 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 VoidResponse removeProcess(String serverName,
                                  String userId,
                                  String processGUID,
                                  MetadataCorrelationProperties requestBody)

Remove the metadata element representing a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the metadata element to remove

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or 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 ProcessElementsResponse findProcesses(String serverName,
                                             String userId,
                                             int startFrom,
                                             int pageSize,
                                             SearchStringRequestBody requestBody)

Retrieve the list of process metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - string to find in the properties

Returns:

list of matching metadata elements or InvalidParameterException one of the parameters is invalid or UserNotAuthorizedException the user is not authorized to issue this request or PropertyServerException there is a problem reported in the open metadata server(s)

getProcessesForAssetManager

public ProcessElementsResponse getProcessesForAssetManager(String serverName,
                                                           String userId,
                                                           int startFrom,
                                                           int pageSize,
                                                           AssetManagerIdentifiersRequestBody requestBody)

Return the list of processes associated with the process manager.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

list of metadata elements describing the processes associated with the requested asset manager or 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 ProcessElementsResponse getProcessesByName(String serverName,
                                                  String userId,
                                                  int startFrom,
                                                  int pageSize,
                                                  NameRequestBody requestBody)

Retrieve the list of process metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements or 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 ProcessElementResponse getProcessByGUID(String serverName,
                                               String userId,
                                               String processGUID,
                                               AssetManagerIdentifiersRequestBody requestBody)

Retrieve the process metadata element with the supplied unique identifier.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the requested metadata element

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

requested metadata element or 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 ProcessElementResponse getProcessParent(String serverName,
                                               String userId,
                                               String processGUID,
                                               AssetManagerIdentifiersRequestBody requestBody)

Retrieve the process metadata element with the supplied unique identifier.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the requested metadata element

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

parent process element or 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 ProcessElementsResponse getSubProcesses(String serverName,
                                               String userId,
                                               String processGUID,
                                               int startFrom,
                                               int pageSize,
                                               AssetManagerIdentifiersRequestBody requestBody)

Retrieve the process metadata element with the supplied unique identifier.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the requested metadata element

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

list of process elements or 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)

createPort

public GUIDResponse createPort(String serverName,
                               String userId,
                               boolean assetManagerIsHome,
                               String processGUID,
                               PortRequestBody requestBody)

Create a new metadata element to represent a port.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the process manager can update this port

processGUID - unique identifier of the process where the port is located

requestBody - properties for the port

Returns:

unique identifier of the new metadata element for the port or 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)

updatePort

public VoidResponse updatePort(String serverName,
                               String userId,
                               String portGUID,
                               PortRequestBody requestBody)

Update the properties of the metadata element representing a port. This call replaces all existing properties with the supplied properties.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portGUID - unique identifier of the port to update

requestBody - new properties for the port

Returns:

void or 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)

setupProcessPort

public VoidResponse setupProcessPort(String serverName,
                                     String userId,
                                     boolean assetManagerIsHome,
                                     String processGUID,
                                     String portGUID,
                                     AssetManagerIdentifiersRequestBody requestBody)

Link a port to a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the process manager can update this process

processGUID - unique identifier of the process

portGUID - unique identifier of the port

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)

clearProcessPort

public VoidResponse clearProcessPort(String serverName,
                                     String userId,
                                     String processGUID,
                                     String portGUID,
                                     AssetManagerIdentifiersRequestBody requestBody)

Unlink a port from a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the process

portGUID - unique identifier of the port

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)

setupPortDelegation

public VoidResponse setupPortDelegation(String serverName,
                                        String userId,
                                        boolean assetManagerIsHome,
                                        String portOneGUID,
                                        String portTwoGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)

Link two ports together to show that portTwo is an implementation of portOne. (That is, portOne delegates to portTwo.)

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the process manager can update this process

portOneGUID - unique identifier of the port at end 1

portTwoGUID - unique identifier of the port at end 2

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)

clearPortDelegation

public VoidResponse clearPortDelegation(String serverName,
                                        String userId,
                                        String portOneGUID,
                                        String portTwoGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)

Remove the port delegation relationship between two ports.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portOneGUID - unique identifier of the port at end 1

portTwoGUID - unique identifier of the port at end 2

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)

setupPortSchemaType

public VoidResponse setupPortSchemaType(String serverName,
                                        String userId,
                                        boolean assetManagerIsHome,
                                        String portGUID,
                                        String schemaTypeGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)

Link a schema type to a port to show the structure of data it accepts.

Parameters:

serverName - name of the server to route the request to

userId - calling user

assetManagerIsHome - ensure that only the process manager can update this process

portGUID - unique identifier of the port

schemaTypeGUID - unique identifier of the schemaType

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)

clearPortSchemaType

public VoidResponse clearPortSchemaType(String serverName,
                                        String userId,
                                        String portGUID,
                                        String schemaTypeGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)

Remove the schema type from a port.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portGUID - unique identifier of the port

schemaTypeGUID - unique identifier of the schemaType

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)

removePort

public VoidResponse removePort(String serverName,
                               String userId,
                               String portGUID,
                               MetadataCorrelationProperties requestBody)

Remove the metadata element representing a port.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portGUID - unique identifier of the metadata element to remove

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or 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)

findPorts

public PortElementsResponse findPorts(String serverName,
                                      String userId,
                                      int startFrom,
                                      int pageSize,
                                      SearchStringRequestBody requestBody)

Retrieve the list of port metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - string to find in the properties

Returns:

list of matching metadata elements or 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)

getPortsForProcess

public PortElementsResponse getPortsForProcess(String serverName,
                                               String userId,
                                               String processGUID,
                                               int startFrom,
                                               int pageSize,
                                               AssetManagerIdentifiersRequestBody requestBody)

Retrieve the list of ports associated with a process.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processGUID - unique identifier of the process of interest

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

list of associated metadata elements or 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)

getPortUse

public PortElementsResponse getPortUse(String serverName,
                                       String userId,
                                       String portGUID,
                                       int startFrom,
                                       int pageSize,
                                       AssetManagerIdentifiersRequestBody requestBody)

Retrieve the list of ports that delegate to this port.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portGUID - unique identifier of the starting port

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

list of associated metadata elements or 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)

getPortDelegation

public PortElementResponse getPortDelegation(String serverName,
                                             String userId,
                                             String portGUID,
                                             AssetManagerIdentifiersRequestBody requestBody)

Retrieve the port that this port delegates to.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portGUID - unique identifier of the starting port alias

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

matching metadata element or 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)

getPortsByName

public PortElementsResponse getPortsByName(String serverName,
                                           String userId,
                                           int startFrom,
                                           int pageSize,
                                           NameRequestBody requestBody)

Retrieve the list of port metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:

serverName - name of the server to route the request to

userId - calling user

startFrom - paging start point

pageSize - maximum results that can be returned

requestBody - name to search for

Returns:

list of matching metadata elements or 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)

getPortByGUID

public PortElementResponse getPortByGUID(String serverName,
                                         String userId,
                                         String portGUID,
                                         AssetManagerIdentifiersRequestBody requestBody)

Retrieve the port metadata element with the supplied unique identifier.

Parameters:

serverName - name of the server to route the request to

userId - calling user

portGUID - unique identifier of the requested metadata element

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

matching metadata element or 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 VoidResponse setBusinessSignificant(String serverName,
                                           String userId,
                                           String elementGUID,
                                           MetadataCorrelationProperties requestBody)

Classify a port, process or process as "BusinessSignificant" (this may effect the way that lineage is displayed).

Parameters:

serverName - name of the server to route the request to

userId - calling user

elementGUID - unique identifier of the metadata element to update

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or 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 VoidResponse clearBusinessSignificant(String serverName,
                                             String userId,
                                             String elementGUID,
                                             MetadataCorrelationProperties requestBody)

Remove the "BusinessSignificant" designation from the element.

Parameters:

serverName - name of the server to route the request to

userId - calling user

elementGUID - unique identifier of the metadata element to update

requestBody - properties to help with the mapping of the elements in the external asset manager and open metadata

Returns:

void or 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 GUIDResponse setupDataFlow(String serverName,
                                  String userId,
                                  String dataSupplierGUID,
                                  String dataConsumerGUID,
                                  boolean assetManagerIsHome,
                                  DataFlowRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

dataSupplierGUID - unique identifier of the data supplier

dataConsumerGUID - unique identifier of the data consumer

assetManagerIsHome - ensure that only the process manager can update this process

requestBody - properties of the relationship

Returns:

unique identifier of the relationship or 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 DataFlowElementResponse getDataFlow(String serverName,
                                           String userId,
                                           String dataSupplierGUID,
                                           String dataConsumerGUID,
                                           NameRequestBody requestBody)

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.

Parameters:

serverName - name of the server to route the request to

userId - calling user

dataSupplierGUID - unique identifier of the data supplier

dataConsumerGUID - unique identifier of the data consumer

requestBody - optional name to search for

Returns:

unique identifier and properties of the relationship or 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 VoidResponse updateDataFlow(String serverName,
                                   String userId,
                                   String dataFlowGUID,
                                   DataFlowRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

dataFlowGUID - unique identifier of the data flow relationship

requestBody - properties of the relationship

Returns:

void or 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 VoidResponse clearDataFlow(String serverName,
                                  String userId,
                                  String dataFlowGUID,
                                  AssetManagerIdentifiersRequestBody requestBody)

Remove the data flow relationship between two elements.

Parameters:

serverName - name of the server to route the request to

userId - calling user

dataFlowGUID - unique identifier of the data flow relationship

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 DataFlowElementsResponse getDataFlowConsumers(String serverName,
                                                     String userId,
                                                     String dataSupplierGUID,
                                                     AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

dataSupplierGUID - unique identifier of the data supplier

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

unique identifier and properties of the relationship or 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 DataFlowElementsResponse getDataFlowSuppliers(String serverName,
                                                     String userId,
                                                     String dataConsumerGUID,
                                                     AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

dataConsumerGUID - unique identifier of the data consumer

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

unique identifier and properties of the relationship or 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 GUIDResponse setupControlFlow(String serverName,
                                     String userId,
                                     String currentStepGUID,
                                     String nextStepGUID,
                                     boolean assetManagerIsHome,
                                     ControlFlowRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

currentStepGUID - unique identifier of the previous step

nextStepGUID - unique identifier of the next step

assetManagerIsHome - ensure that only the process manager can update this process

requestBody - properties of the relationship

Returns:

unique identifier for the control flow relationship or 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 ControlFlowElementResponse getControlFlow(String serverName,
                                                 String userId,
                                                 String currentStepGUID,
                                                 String nextStepGUID,
                                                 NameRequestBody requestBody)

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.

Parameters:

serverName - name of the server to route the request to

userId - calling user

currentStepGUID - unique identifier of the previous step

nextStepGUID - unique identifier of the next step

requestBody - unique identifier for this relationship

Returns:

unique identifier and properties of the relationship or 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 VoidResponse updateControlFlow(String serverName,
                                      String userId,
                                      String controlFlowGUID,
                                      ControlFlowRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

controlFlowGUID - unique identifier of the control flow relationship

requestBody - properties of the relationship

Returns:

void or 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 VoidResponse clearControlFlow(String serverName,
                                     String userId,
                                     String controlFlowGUID,
                                     AssetManagerIdentifiersRequestBody requestBody)

Remove the control flow relationship between two elements.

Parameters:

serverName - name of the server to route the request to

userId - calling user

controlFlowGUID - unique identifier of the control flow relationship

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 ControlFlowElementsResponse getControlFlowNextSteps(String serverName,
                                                           String userId,
                                                           String currentStepGUID,
                                                           AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

currentStepGUID - unique identifier of the current step

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

unique identifier and properties of the relationship or 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 ControlFlowElementsResponse getControlFlowPreviousSteps(String serverName,
                                                               String userId,
                                                               String currentStepGUID,
                                                               AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

currentStepGUID - unique identifier of the previous step

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

unique identifier and properties of the relationship or 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 GUIDResponse setupProcessCall(String serverName,
                                     String userId,
                                     String callerGUID,
                                     String calledGUID,
                                     boolean assetManagerIsHome,
                                     ProcessCallRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

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

assetManagerIsHome - ensure that only the process manager can update this process

requestBody - properties of the relationship

Returns:

unique identifier of the new relationship or 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 ProcessCallElementResponse getProcessCall(String serverName,
                                                 String userId,
                                                 String callerGUID,
                                                 String calledGUID,
                                                 NameRequestBody requestBody)

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.

Parameters:

serverName - name of the server to route the request to

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

requestBody - unique identifier for this relationship

Returns:

unique identifier and properties of the relationship or 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 VoidResponse updateProcessCall(String serverName,
                                      String userId,
                                      String processCallGUID,
                                      ProcessCallRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

processCallGUID - unique identifier of the process call relationship

requestBody - properties of the relationship

Returns:

void or 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 VoidResponse clearProcessCall(String serverName,
                                     String userId,
                                     String processCallGUID,
                                     AssetManagerIdentifiersRequestBody requestBody)

Remove the process call relationship.

Parameters:

serverName - name of the server to route the request to

userId - calling user

processCallGUID - unique identifier of the process call relationship

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 ProcessCallElementsResponse getProcessCalled(String serverName,
                                                    String userId,
                                                    String callerGUID,
                                                    AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

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

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

unique identifier and properties of the relationship or 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 ProcessCallElementsResponse getProcessCallers(String serverName,
                                                     String userId,
                                                     String calledGUID,
                                                     AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

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

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

unique identifier and properties of the relationship or 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 VoidResponse setupLineageMapping(String serverName,
                                        String userId,
                                        String sourceElementGUID,
                                        String destinationElementGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)

Link to 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.

Parameters:

serverName - name of the server to route the request to

userId - calling user

sourceElementGUID - unique identifier of the source

destinationElementGUID - unique identifier of the destination

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 VoidResponse clearLineageMapping(String serverName,
                                        String userId,
                                        String sourceElementGUID,
                                        String destinationElementGUID,
                                        AssetManagerIdentifiersRequestBody requestBody)

Remove the lineage mapping between two elements.

Parameters:

serverName - name of the server to route the request to

userId - calling user

sourceElementGUID - unique identifier of the source

destinationElementGUID - unique identifier of the destination

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 LineageMappingElementsResponse getDestinationLineageMappings(String serverName,
                                                                    String userId,
                                                                    String sourceElementGUID,
                                                                    AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

sourceElementGUID - unique identifier of the source

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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 LineageMappingElementsResponse getSourceLineageMappings(String serverName,
                                                               String userId,
                                                               String destinationElementGUID,
                                                               AssetManagerIdentifiersRequestBody requestBody)

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

Parameters:

serverName - name of the server to route the request to

userId - calling user

destinationElementGUID - unique identifier of the destination

requestBody - unique identifiers of software server capability representing the caller (optional)

Returns:

void or 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)