Package org.odpi.openmetadata.viewservices.assetcatalog.server.spring

Class OpenLineageController

java.lang.Object

org.odpi.openmetadata.viewservices.assetcatalog.server.spring.OpenLineageController

@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/asset-catalog/old/lineage")
@Deprecated
public class OpenLineageController
extends Object

Deprecated.

This controller serves all requests for retrieving lineage details, both vertical and horizontal. It originated in the Egeria UI application. It is deprecated because it does not follow the exception handling rules for Egeria code. The replacement services are in AssetCatalogResource.

Constructor Summary

Constructors

Constructor	Description
OpenLineageController()	Deprecated.

Method Summary

Modifier and Type	Method	Description
Graph	getElementHierarchy(String serverName, ElementHierarchyRequest elementHierarchyRequest)	Deprecated. Returns a subgraph representing the hierarchy of a certain node, based on the request.
Graph	getEndToEndLineage(String serverName, String guid, boolean includeProcesses)	Deprecated. Return the graph of nodes that describe the end-to-end lineage for the starting element.
LineageVertex	getLineageVertex(String serverName, String guid)	Deprecated. Gets entity details.
List<String>	getNodes(String serverName, String type, String searchValue, int limit)	Deprecated. Gets nodes names of certain type with display name containing a certain value.
Graph	getSemanticLineage(String serverName, String guid, boolean includeProcesses)	Deprecated. Retrieve details of the asset related elements linked to a glossary term via the semantic assignment relationship.
List<String>	getTypes(String serverName)	Deprecated. Retrieves available entity types from lineage repository.
Graph	getUltimateDestination(String serverName, String guid, boolean includeProcesses)	Deprecated. Return the nodes and relationships that describe the know ultimate destinations of the starting element.
Graph	getUltimateSource(String serverName, String guid, boolean includeProcesses)	Deprecated. Return the nodes and relationships that describe the know ultimate sources of the starting element.
List<LineageVertex>	searchForVertices(String serverName, LineageSearchRequest searchRequest)	Deprecated. Returns the nodes that the user will initially see when querying lineage.

Methods inherited from class java.lang.Object

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

Constructor Details

OpenLineageController

public OpenLineageController()

Deprecated.

Method Details

getUltimateSource

@GetMapping("/entities/{guid}/ultimate-source")
public Graph getUltimateSource(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid,
 @RequestParam
 boolean includeProcesses)
                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Return the nodes and relationships that describe the know ultimate sources of the starting element.

Parameters:

serverName - name of the server to route the request to

guid - unique identifier of the starting element

includeProcesses - if true Process nodes will be included

Returns:

graph of nodes and edges describing the ultimate sources of the asset

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getEndToEndLineage

@GetMapping({"/entities/{guid}/end-to-end","/entities/{guid}/end2end"})
public Graph getEndToEndLineage(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid,
 @RequestParam
 boolean includeProcesses)
                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Return the graph of nodes that describe the end-to-end lineage for the starting element.

Parameters:

serverName - name of the server to route the request to

guid - unique identifier of the starting element

includeProcesses - if true Process nodes will be included

Returns:

graph of nodes and edges describing the end to end flow

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getUltimateDestination

@GetMapping("/entities/{guid}/ultimate-destination")
public Graph getUltimateDestination(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid,
 @RequestParam
 boolean includeProcesses)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Return the nodes and relationships that describe the know ultimate destinations of the starting element.

Parameters:

serverName - name of the server to route the request to

guid - unique identifier of the starting element

includeProcesses - if true Process nodes will be included

Returns:

graph of nodes and edges describing the ultimate destination of the asset

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getSemanticLineage

@GetMapping({"/entities/{guid}/vertical-lineage","/entities/{guid}/semantic-lineage"})
public Graph getSemanticLineage(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid,
 @RequestParam
 boolean includeProcesses)
                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Retrieve details of the asset related elements linked to a glossary term via the semantic assignment relationship.

Parameters:

serverName - name of the server to route the request to

guid - unique identifier of the starting glossary term element

includeProcesses - if true Process nodes will be included

Returns:

graph of nodes and edges describing the assets linked to the glossary term

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getLineageVertex

@GetMapping("entities/{guid}/details")
public LineageVertex getLineageVertex(@PathVariable
 String serverName,
 @PathVariable("guid")
 String guid)
                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Gets entity details.

Parameters:

serverName - name of the server to route the request to

guid - of the Entity to be retrieved

Returns:

the entity details

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getTypes

@GetMapping("types")
public List<String> getTypes(@PathVariable
 String serverName)
                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Retrieves available entity types from lineage repository.

Parameters:

serverName - name of the server to route the request to

Returns:

the available entities types

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getNodes

@GetMapping("nodes")
public List<String> getNodes(@PathVariable
 String serverName,
 @RequestParam("type")
 String type,
 @RequestParam("name")
 String searchValue,
 @RequestParam("limit")
 int limit)
                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Gets nodes names of certain type with display name containing a certain value.

Parameters:

serverName - name of the server to route the request to

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

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

searchForVertices

@PostMapping("entities/search")
public List<LineageVertex> searchForVertices(@PathVariable
 String serverName,
 @RequestBody
 LineageSearchRequest searchRequest)
                                      throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Returns the nodes that the user will initially see when querying lineage. In the future, this method will be extended to condense large paths to prevent cluttering of the users screen. The user will be able to extend the condensed path by querying a different method.

Parameters:

serverName - name of the server to route the request to

searchRequest - filtering details for the search

Returns:

the entity details

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service

getElementHierarchy

@PostMapping("elements/hierarchy")
public Graph getElementHierarchy(@PathVariable
 String serverName,
 @RequestBody
 ElementHierarchyRequest elementHierarchyRequest)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Deprecated.

Returns a subgraph representing the hierarchy of a certain node, based on the request.

Parameters:

serverName - name of the server to route the request to

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,

Throws:

InvalidParameterException - from the underlying service

PropertyServerException - from the underlying service

UserNotAuthorizedException - from the underlying service