org.odpi.openmetadata.accessservices.dataengine.client

Class DataEngineEventClient

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.client.DataEngineEventClient

All Implemented Interfaces:

DataEngineClient

public class DataEngineEventClient
extends Object
implements DataEngineClient

DataEngineEventClient implements Data Engine client side events interface using provided topic connector. For more information see DataEngineClient interface definition.

Constructor Summary

Constructors

Constructor and Description
DataEngineEventClient(DataEngineInTopicClientConnector dataEngineInTopicClientConnector) Constructor to create DataEngineEventClient with unauthenticated access to the server

Method Summary

Modifier and Type	Method and Description
void	addLineageMappings(String userId, List<LineageMapping> lineageMappings) Add lineage mapping relationships between schema types
void	addPortsToProcess(String userId, List<String> portGUIDs, String processGUID) Add ports and process ports relationship to an existing port
String	addProcessHierarchy(String userId, ProcessHierarchy processHierarchy) Add a ProcessHierarchy relationship to a process
String	createExternalDataEngine(String userId, SoftwareServerCapability softwareServerCapability) Create or update the software server capability entity
String	createOrUpdatePortAlias(String userId, PortAlias portAlias) Create or update the port alias entity with a PortDelegation relationship
String	createOrUpdatePortImplementation(String userId, PortImplementation portImplementation) Create or update the port implementation entity,with the corresponding schema type and port schema relationship
List<String>	createOrUpdateProcesses(String userId, List<Process> processes) Create or update the processes, with all the ports, schema types and corresponding relationships including process hierarchy relationships.
String	createOrUpdateSchemaType(String userId, SchemaType schemaType) Create or update the schema type entity, with the corresponding schema attributes and relationships
String	getExternalSourceName() Returns the name of the source system using data engine client
void	setExternalSourceName(String externalSourceName) Sets external source system name using the data engine client

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineEventClient

public DataEngineEventClient(DataEngineInTopicClientConnector dataEngineInTopicClientConnector)

Constructor to create DataEngineEventClient with unauthenticated access to the server

Parameters:

dataEngineInTopicClientConnector - topic connector used to publish to InTopic

Method Detail

createOrUpdateProcesses

public List<String> createOrUpdateProcesses(String userId,
                                            List<Process> processes)
                                     throws InvalidParameterException,
                                            ConnectorCheckedException

Create or update the processes, with all the ports, schema types and corresponding relationships including process hierarchy relationships.

Specified by:

createOrUpdateProcesses in interface DataEngineClient

Parameters:

userId - the name of the calling user

processes - list of processes

Returns:

unique identifier of the process in the repository

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

createExternalDataEngine

public String createExternalDataEngine(String userId,
                                       SoftwareServerCapability softwareServerCapability)
                                throws InvalidParameterException,
                                       ConnectorCheckedException

Create or update the software server capability entity

Specified by:

createExternalDataEngine in interface DataEngineClient

Parameters:

userId - the name of the calling user

softwareServerCapability - the software server capability bean

Returns:

unique identifier of the server in the repository

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

createOrUpdateSchemaType

public String createOrUpdateSchemaType(String userId,
                                       SchemaType schemaType)
                                throws InvalidParameterException,
                                       ConnectorCheckedException

Create or update the schema type entity, with the corresponding schema attributes and relationships

Specified by:

createOrUpdateSchemaType in interface DataEngineClient

Parameters:

userId - the name of the calling user

schemaType - the schema type bean

Returns:

unique identifier of the schema type in the repository

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

createOrUpdatePortImplementation

public String createOrUpdatePortImplementation(String userId,
                                               PortImplementation portImplementation)
                                        throws InvalidParameterException,
                                               ConnectorCheckedException

Create or update the port implementation entity,with the corresponding schema type and port schema relationship

Specified by:

createOrUpdatePortImplementation in interface DataEngineClient

Parameters:

userId - the name of the calling user

portImplementation - the port implementation bean

Returns:

unique identifier of the port implementation in the repository

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

createOrUpdatePortAlias

public String createOrUpdatePortAlias(String userId,
                                      PortAlias portAlias)
                               throws InvalidParameterException,
                                      ConnectorCheckedException

Create or update the port alias entity with a PortDelegation relationship

Specified by:

createOrUpdatePortAlias in interface DataEngineClient

Parameters:

userId - the name of the calling user

portAlias - the port alias bean

Returns:

unique identifier of the port alias in the repository

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

addProcessHierarchy

public String addProcessHierarchy(String userId,
                                  ProcessHierarchy processHierarchy)
                           throws InvalidParameterException,
                                  ConnectorCheckedException

Add a ProcessHierarchy relationship to a process

Specified by:

addProcessHierarchy in interface DataEngineClient

Parameters:

userId - the name of the calling user

processHierarchy - the process hierarchy bean

Returns:

the unique identifier (guid) of the child of the process hierarchy that was updated

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

addLineageMappings

public void addLineageMappings(String userId,
                               List<LineageMapping> lineageMappings)
                        throws InvalidParameterException,
                               ConnectorCheckedException

Add lineage mapping relationships between schema types

Specified by:

addLineageMappings in interface DataEngineClient

Parameters:

userId - the name of the calling user

lineageMappings - list of lineage mappings

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

addPortsToProcess

public void addPortsToProcess(String userId,
                              List<String> portGUIDs,
                              String processGUID)
                       throws InvalidParameterException,
                              ConnectorCheckedException

Add ports and process ports relationship to an existing port

Specified by:

addPortsToProcess in interface DataEngineClient

Parameters:

userId - the name of the calling user

portGUIDs - the list of port GUIDs

processGUID - the process GUYID

Throws:

InvalidParameterException - the bean properties are invalid

ConnectorCheckedException - problem with the underlying connector (if used)

setExternalSourceName

public void setExternalSourceName(String externalSourceName)

Sets external source system name using the data engine client

Specified by:

setExternalSourceName in interface DataEngineClient

Parameters:

externalSourceName - Source system name

getExternalSourceName

public String getExternalSourceName()

Returns the name of the source system using data engine client

Specified by:

getExternalSourceName in interface DataEngineClient

Returns:

Source system name