Package org.odpi.openmetadata.userinterface.uichassis.springboot.service

Class OpenLineageService

java.lang.Object

org.odpi.openmetadata.userinterface.uichassis.springboot.service.OpenLineageService

@Service
public class OpenLineageService
extends Object

This class responsibility is to interact with Open Lineage Services(OLS), process the returned response and return it in a format understood by view

Constructor Summary

Constructors

Constructor	Description
OpenLineageService(OpenLineageClient openLineageClient, LineageGraphDisplayService lineageGraphDisplayService)

Method Summary

Modifier and Type	Method	Description
Graph	getEndToEndLineage(String userId, String guid, boolean includeProcesses)
LineageVertex	getEntityDetails(String userId, String guid)	Gets node details.
Graph	getUltimateDestination(String userId, String guid, boolean includeProcesses)
Graph	getUltimateSource(String userId, String guid, boolean includeProcesses)
Graph	getVerticalLineage(String userId, String guid, boolean includeProcesses)

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenLineageService

@Autowired
public OpenLineageService(OpenLineageClient openLineageClient,
                          LineageGraphDisplayService lineageGraphDisplayService)

Parameters:

openLineageClient - client to connect to open lineage services

lineageGraphDisplayService - the rules for display

Method Detail

getUltimateSource

public Graph getUltimateSource(String userId,
                               String guid,
                               boolean includeProcesses)
                        throws InvalidParameterException,
                               PropertyServerException,
                               OpenLineageException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the ultimate sources for the asset

Throws:

InvalidParameterException

PropertyServerException

OpenLineageException

getEndToEndLineage

public Graph getEndToEndLineage(String userId,
                                String guid,
                                boolean includeProcesses)
                         throws InvalidParameterException,
                                PropertyServerException,
                                OpenLineageException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the end to end flow

Throws:

InvalidParameterException

PropertyServerException

OpenLineageException

getUltimateDestination

public Graph getUltimateDestination(String userId,
                                    String guid,
                                    boolean includeProcesses)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    OpenLineageException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the ultimate destinations of the asset

Throws:

InvalidParameterException

PropertyServerException

OpenLineageException

getVerticalLineage

public Graph getVerticalLineage(String userId,
                                String guid,
                                boolean includeProcesses)
                         throws InvalidParameterException,
                                PropertyServerException,
                                OpenLineageException

Parameters:

userId - id of the user triggering the request

guid - unique identifier if the asset

includeProcesses - if true includes processes in the response

Returns:

map of nodes and edges describing the glossary terms linked to the asset

Throws:

InvalidParameterException

PropertyServerException

OpenLineageException

getEntityDetails

public LineageVertex getEntityDetails(String userId,
                                      String guid)
                               throws InvalidParameterException,
                                      PropertyServerException,
                                      OpenLineageException

Gets node details.

Parameters:

userId - the user id

guid - the guid

Returns:

the node details

Throws:

InvalidParameterException

PropertyServerException

OpenLineageException