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

Class OpenLineageService

java.lang.Object
org.odpi.openmetadata.userinterface.uichassis.springboot.service.OpenLineageService
@Service @EnableConfigurationProperties(LineageGraphDisplayService.class) 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 Details

    • OpenLineageService

      @Autowired public OpenLineageService(org.odpi.openmetadata.governanceservers.openlineage.client.OpenLineageClient openLineageClient, LineageGraphDisplayService lineageGraphDisplayService)
      Parameters:
      openLineageClient - client to connect to open lineage services
      lineageGraphDisplayService - the rules for display

  • Method Details

    • getUltimateSource

      public Graph getUltimateSource(String userId, String guid, boolean includeProcesses) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - from the underlying client
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - from the underlying client
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - from the underlying client

    • getEndToEndLineage

      public Graph getEndToEndLineage(String userId, String guid, boolean includeProcesses) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - from the underlying client
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - from the underlying client
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - from the underlying client

    • getUltimateDestination

      public Graph getUltimateDestination(String userId, String guid, boolean includeProcesses) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - from the underlying client
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - from the underlying client
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - from the underlying client

    • getVerticalLineage

      public Graph getVerticalLineage(String userId, String guid, boolean includeProcesses) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.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:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - from the underlying client
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - from the underlying client
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - from the underlying client

    • getEntityDetails

      public org.odpi.openmetadata.governanceservers.openlineage.model.LineageVertex getEntityDetails(String userId, String guid) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Gets node details.
      Parameters:
      userId - the user id
      guid - the guid
      Returns:
      the node details
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - from the underlying client
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - from the underlying client
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - from the underlying client

    • search

      public List<org.odpi.openmetadata.governanceservers.openlineage.model.LineageVertex> search(String userId, org.odpi.openmetadata.governanceservers.openlineage.requests.LineageSearchRequest lineageSearchRequest) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException
      Gets node details.
      Parameters:
      userId - the user id
      lineageSearchRequest - the body for search
      Returns:
      the node details
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - from the underlying client
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - from the underlying client
      org.odpi.openmetadata.governanceservers.openlineage.ffdc.OpenLineageException - from the underlying client

    • getTypes

      public List<String> getTypes(String userId)
      Gets available entities types from lineage repository.
      Parameters:
      userId - user ID
      Returns:
      the available entities types

    • getNodes

      public List<String> getNodes(String userId, String type, String searchValue, int limit)
      Gets nodes names of certain type with display name containing a certain value.
      Parameters:
      userId - user ID
      type - the type of the nodes name to search for
      searchValue - the string to be contained in the qualified name of the node - case insensitive
      limit - the maximum number of node names to retrieve
      Returns:
      the list of node names

    • getElementHierarchy

      public Graph getElementHierarchy(String userId, org.odpi.openmetadata.governanceservers.openlineage.requests.ElementHierarchyRequest elementHierarchyRequest)
      Returns a subraph representing the hierarchy of a certain node, based on the request
      Parameters:
      elementHierarchyRequest - contains the guid of the queried node and the hierarchyType of the display name of the nodes
      Returns:
      a subgraph containing all relevant paths,