Package org.odpi.openmetadata.accessservices.dataengine.client

Interface DataEngineClient

All Known Implementing Classes:

DataEngineEventClient, DataEngineRESTClient, DataEngineRESTConfigurationClient

public interface DataEngineClient

DataEngineClient provides the client-side interface for a data engine tool to create processes with ports, schemas and relationships.

Method Summary

Modifier and Type	Method	Description
void	addLineageMappings(String userId, List<LineageMapping> lineageMappings)	Add lineage mapping relationships between schema types
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, String processQualifiedName)	Create or update the port alias entity with a PortDelegation relationship.
String	createOrUpdatePortImplementation(String userId, PortImplementation portImplementation, String processQualifiedName)	Create or update the port implementation entity,with the corresponding schema type and port schema relationship.
String	createOrUpdateProcess(String userId, Process process)	Create or update the process, with all the ports, schema types and corresponding relationships including the process hierarchy relationship.
String	createOrUpdateSchemaType(String userId, SchemaType schemaType)	Create or update the schema type entity, with the corresponding schema attributes and relationships
void	deleteConnection(String userId, String qualifiedName, String guid)	Delete the connection
void	deleteDatabase(String userId, String qualifiedName, String guid)	Delete the database
void	deleteDatabaseSchema(String userId, String qualifiedName, String guid)	Delete the database schema
void	deleteDataFile(String userId, String qualifiedName, String guid)	Delete the data file
void	deleteEndpoint(String userId, String qualifiedName, String guid)	Delete the endpoint
void	deleteEventType(String userId, String qualifiedName, String guid)	Delete the event type
void	deleteExternalDataEngine(String userId, String qualifiedName, String guid)	Delete the external data engine
void	deleteFolder(String userId, String qualifiedName, String guid)	Delete the folder
void	deletePortAlias(String userId, String qualifiedName, String guid)	Delete the port alias
void	deletePortImplementation(String userId, String qualifiedName, String guid)	Delete the port implementation
void	deleteProcess(String userId, String qualifiedName, String guid)	Delete a process
void	deleteRelationalTable(String userId, String qualifiedName, String guid)	Delete the relational table
void	deleteSchemaType(String userId, String qualifiedName, String guid)	Delete the schema type
void	deleteTopic(String userId, String qualifiedName, String guid)	Delete the topic
GUIDListResponse	find(String userId, FindRequestBody findRequestBody)	Find an entity
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
String	upsertDatabase(String userId, Database database, boolean incomplete)	Create or update the database entity
String	upsertDatabaseSchema(String userId, DatabaseSchema databaseSchema, String databaseQualifiedName, boolean incomplete)	Create or update the database schema entity
String	upsertDataFile(String userId, DataFile dataFile, boolean incomplete)	Create or update the data file entity
String	upsertEventType(String userId, EventType eventType, String topicQualifiedName)	Create or update the event type entity
String	upsertRelationalTable(String userId, RelationalTable relationalTable, String databaseSchemaQualifiedName, boolean incomplete)	Create or update the relational table entity
String	upsertTopic(String userId, Topic topic)	Create or update the topic entity

Method Detail

createOrUpdateProcess

String createOrUpdateProcess(String userId,
                             Process process)
                      throws InvalidParameterException,
                             PropertyServerException,
                             UserNotAuthorizedException,
                             ConnectorCheckedException

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

Parameters:

userId - the name of the calling user

process - the process

Returns:

unique identifier of the process in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteProcess

void deleteProcess(String userId,
                   String qualifiedName,
                   String guid)
            throws InvalidParameterException,
                   PropertyServerException,
                   UserNotAuthorizedException,
                   ConnectorCheckedException

Delete a process

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the process to be deleted

guid - the unique identifier of the process to be deleted

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

createExternalDataEngine

String createExternalDataEngine(String userId,
                                SoftwareServerCapability softwareServerCapability)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException,
                                ConnectorCheckedException

Create or update the software server capability entity

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

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteExternalDataEngine

void deleteExternalDataEngine(String userId,
                              String qualifiedName,
                              String guid)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException,
                              ConnectorCheckedException

Delete the external data engine

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the external data engine

guid - the unique identifier of the external data engine

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

createOrUpdateSchemaType

String createOrUpdateSchemaType(String userId,
                                SchemaType schemaType)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException,
                                ConnectorCheckedException

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

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

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteSchemaType

void deleteSchemaType(String userId,
                      String qualifiedName,
                      String guid)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException,
                      ConnectorCheckedException

Delete the schema type

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the schema type

guid - the unique identifier of the schema type

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

createOrUpdatePortImplementation

String createOrUpdatePortImplementation(String userId,
                                        PortImplementation portImplementation,
                                        String processQualifiedName)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException,
                                        ConnectorCheckedException

Create or update the port implementation entity,with the corresponding schema type and port schema relationship. It attaches the port implementation to the provided process

Parameters:

userId - the name of the calling user

portImplementation - the port implementation bean

processQualifiedName - the process qualified name

Returns:

unique identifier of the port implementation in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

deletePortImplementation

void deletePortImplementation(String userId,
                              String qualifiedName,
                              String guid)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException,
                              ConnectorCheckedException

Delete the port implementation

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of port implementation

guid - the unique identifier of the port implementation

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

createOrUpdatePortAlias

String createOrUpdatePortAlias(String userId,
                               PortAlias portAlias,
                               String processQualifiedName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException,
                               ConnectorCheckedException

Create or update the port alias entity with a PortDelegation relationship. It attaches the port alias to the provided process

Parameters:

userId - the name of the calling user

portAlias - the port alias bean

processQualifiedName - the process qualified name

Returns:

unique identifier of the port alias in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

deletePortAlias

void deletePortAlias(String userId,
                     String qualifiedName,
                     String guid)
              throws InvalidParameterException,
                     PropertyServerException,
                     UserNotAuthorizedException,
                     ConnectorCheckedException

Delete the port alias

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the port alias

guid - the unique identifier of the port alias

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

addProcessHierarchy

String addProcessHierarchy(String userId,
                           ProcessHierarchy processHierarchy)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException,
                           ConnectorCheckedException

Add a ProcessHierarchy relationship to a process

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

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

addLineageMappings

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

Add lineage mapping relationships between schema types

Parameters:

userId - the name of the calling user

lineageMappings - list of lineage mappings

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

setExternalSourceName

void setExternalSourceName(String externalSourceName)

Sets external source system name using the data engine client

Parameters:

externalSourceName - Source system name

getExternalSourceName

String getExternalSourceName()

Returns the name of the source system using data engine client

Returns:

Source system name

upsertDatabase

String upsertDatabase(String userId,
                      Database database,
                      boolean incomplete)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException,
                      ConnectorCheckedException

Create or update the database entity

Parameters:

userId - the name of the calling user

database - the database bean

incomplete - determines if the entities inside the database are incomplete or not (database schema and relational tables)

Returns:

unique identifier of database in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

upsertDatabaseSchema

String upsertDatabaseSchema(String userId,
                            DatabaseSchema databaseSchema,
                            String databaseQualifiedName,
                            boolean incomplete)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException,
                            ConnectorCheckedException

Create or update the database schema entity

Parameters:

userId - the name of the calling user

databaseSchema - the database schema bean

databaseQualifiedName - the qualified name of the database, in case it is known

incomplete - indicates whether the asset is incomplete or not

Returns:

unique identifier of database schema in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

upsertRelationalTable

String upsertRelationalTable(String userId,
                             RelationalTable relationalTable,
                             String databaseSchemaQualifiedName,
                             boolean incomplete)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException,
                             ConnectorCheckedException

Create or update the relational table entity

Parameters:

userId - the name of the calling user

relationalTable - the relational table bean

databaseSchemaQualifiedName - the qualified name of the database schema to which it will be related

incomplete - indicates whether the asset is incomplete or not

Returns:

unique identifier of the relational table in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

upsertDataFile

String upsertDataFile(String userId,
                      DataFile dataFile,
                      boolean incomplete)
               throws InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException,
                      ConnectorCheckedException

Create or update the data file entity

Parameters:

userId - the name of the calling user

dataFile - the data file bean

incomplete - should the incomplete classification be added?

Returns:

unique identifier of the relational table in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

deleteDatabase

void deleteDatabase(String userId,
                    String qualifiedName,
                    String guid)
             throws InvalidParameterException,
                    PropertyServerException,
                    UserNotAuthorizedException,
                    ConnectorCheckedException

Delete the database

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the database

guid - the unique identifier of the database

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteDatabaseSchema

void deleteDatabaseSchema(String userId,
                          String qualifiedName,
                          String guid)
                   throws InvalidParameterException,
                          PropertyServerException,
                          UserNotAuthorizedException,
                          ConnectorCheckedException

Delete the database schema

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the database schema

guid - the unique identifier of the database schema

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteRelationalTable

void deleteRelationalTable(String userId,
                           String qualifiedName,
                           String guid)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException,
                           ConnectorCheckedException

Delete the relational table

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the relational table

guid - the unique identifier of the relational table

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteDataFile

void deleteDataFile(String userId,
                    String qualifiedName,
                    String guid)
             throws InvalidParameterException,
                    PropertyServerException,
                    UserNotAuthorizedException,
                    ConnectorCheckedException

Delete the data file

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the data file

guid - the unique identifier of the data file

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteFolder

void deleteFolder(String userId,
                  String qualifiedName,
                  String guid)
           throws InvalidParameterException,
                  PropertyServerException,
                  UserNotAuthorizedException,
                  ConnectorCheckedException

Delete the folder

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the data file

guid - the unique identifier of the folder

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteConnection

void deleteConnection(String userId,
                      String qualifiedName,
                      String guid)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException,
                      ConnectorCheckedException

Delete the connection

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the connection

guid - the unique identifier of the connection

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteEndpoint

void deleteEndpoint(String userId,
                    String qualifiedName,
                    String guid)
             throws InvalidParameterException,
                    PropertyServerException,
                    UserNotAuthorizedException,
                    ConnectorCheckedException

Delete the endpoint

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the endpoint

guid - the unique identifier of the endpoint

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

find

GUIDListResponse find(String userId,
                      FindRequestBody findRequestBody)
               throws ConnectorCheckedException,
                      InvalidParameterException,
                      UserNotAuthorizedException,
                      PropertyServerException,
                      FunctionNotSupportedException

Find an entity

Parameters:

userId - the name of the calling user

findRequestBody - request body

Returns:

list of found entities

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

FunctionNotSupportedException - this request is not supported in the target repositories

upsertTopic

String upsertTopic(String userId,
                   Topic topic)
            throws InvalidParameterException,
                   UserNotAuthorizedException,
                   PropertyServerException,
                   ConnectorCheckedException

Create or update the topic entity

Parameters:

userId - the name of the calling user

topic - the topic bean

Returns:

unique identifier of topic in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

upsertEventType

String upsertEventType(String userId,
                       EventType eventType,
                       String topicQualifiedName)
                throws InvalidParameterException,
                       UserNotAuthorizedException,
                       PropertyServerException,
                       ConnectorCheckedException

Create or update the event type entity

Parameters:

userId - the name of the calling user

eventType - the event type bean

topicQualifiedName - the qualified name of the topic

Returns:

unique identifier of event type in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - internal problem with the connector

deleteTopic

void deleteTopic(String userId,
                 String qualifiedName,
                 String guid)
          throws InvalidParameterException,
                 PropertyServerException,
                 UserNotAuthorizedException,
                 ConnectorCheckedException

Delete the topic

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the topic

guid - the unique identifier of the topic

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)

deleteEventType

void deleteEventType(String userId,
                     String qualifiedName,
                     String guid)
              throws InvalidParameterException,
                     PropertyServerException,
                     UserNotAuthorizedException,
                     ConnectorCheckedException

Delete the event type

Parameters:

userId - the name of the calling user

qualifiedName - the qualified name of the event type

guid - the unique identifier of the event type

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

ConnectorCheckedException - problem with the underlying connector (if used)