Package org.odpi.openmetadata.accessservices.assetlineage

Class AssetLineage

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.assetlineage.AssetLineage

All Implemented Interfaces:

AssetLineageInterface

public class AssetLineage
extends FFDCRESTClient
implements AssetLineageInterface

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
AssetLineage(String serverName, String serverPlatformURLRoot)	Instantiates a new Asset lineage Client.
AssetLineage(String serverName, String serverPlatformURLRoot, String userId, String password)	Instantiates a new Asset Lineage Client.

Method Summary

Modifier and Type	Method	Description
List<String>	publishAssetContext(String userId, String guid, String entityType)	Publishes the asset context of an entity - used for data files and relational tables.
List<String>	publishEntities(String serverName, String userId, String entityType, Optional<Date> updatedAfterDate)	Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic Returns a list that contains entities GUID that were published out.

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorTypeGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Detail

AssetLineage

public AssetLineage(String serverName,
                    String serverPlatformURLRoot)
             throws InvalidParameterException

Instantiates a new Asset lineage Client.

Parameters:

serverName - the server name

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

Throws:

InvalidParameterException - one of the parameters is null or invalid.

InvalidParameterException

AssetLineage

public AssetLineage(String serverName,
                    String serverPlatformURLRoot,
                    String userId,
                    String password)
             throws InvalidParameterException

Instantiates a new Asset Lineage Client.

Parameters:

serverName - the server name

serverPlatformURLRoot - the server platform url root

userId - the user id

password - the password

Throws:

InvalidParameterException - one of the parameters is null or invalid.

InvalidParameterException

Method Detail

publishEntities

public List<String> publishEntities(String serverName,
                                    String userId,
                                    String entityType,
                                    Optional<Date> updatedAfterDate)
                             throws InvalidParameterException,
                                    PropertyServerException,
                                    UserNotAuthorizedException

Scan the cohort based on the given entity type and publish the contexts for the found entities to the out topic Returns a list that contains entities GUID that were published out.

Specified by:

publishEntities in interface AssetLineageInterface

Parameters:

serverName - the server name

userId - the user id

entityType - the entity type

updatedAfterDate - take into account just the entities updated after the specified date, if any (otherwise it loads everything)

Returns:

the list of entities GUIDs that were published out

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

publishAssetContext

public List<String> publishAssetContext(String userId,
                                        String guid,
                                        String entityType)
                                 throws InvalidParameterException,
                                        PropertyServerException,
                                        UserNotAuthorizedException

Publishes the asset context of an entity - used for data files and relational tables.

Specified by:

publishAssetContext in interface AssetLineageInterface

Parameters:

userId - the caller user Id

guid - the guid of the entity

entityType - the entity type

Returns:

list of the entities' guids in the asset context

Throws:

InvalidParameterException - the invalid parameter exception

PropertyServerException - the property server exception

UserNotAuthorizedException - the user not authorized exception