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

Class DataEngineRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

org.odpi.openmetadata.accessservices.dataengine.client.DataEngineRESTClient

All Implemented Interfaces:

DataEngineClient

Direct Known Subclasses:

DataEngineRESTConfigurationClient

public class DataEngineRESTClient
extends OCFRESTClient
implements DataEngineClient

The Data Engine Open Metadata Access Service (OMAS) provides an interface for data engine tools to create processes with ports, schemas and relationships. See interface definition for more explanation.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
DataEngineRESTClient(String serverName, String serverPlatformRootURL)	Create a new client without authentication.
DataEngineRESTClient(String serverName, String serverPlatformRootURL, String userId, String password)	Create a new client that passes userId and password in each HTTP request.

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
DeleteSemantic	getDeleteSemantic()
String	getExternalSourceName()	Returns the name of the source system using data engine client
void	setDeleteSemantic(DeleteSemantic deleteSemantic)
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

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient

callOCFAssetGetRESTCall, callOCFAssetsGetRESTCall, callOCFAssetsPostRESTCall, callOCFConnectionGetRESTCall, callOCFTagGetRESTCall, callOCFTagListGetRESTCall, callOCFTagListPostRESTCall

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

DataEngineRESTClient

public DataEngineRESTClient(String serverName,
                            String serverPlatformRootURL)
                     throws InvalidParameterException

Create a new client without authentication.

Parameters:

serverName - name of the server to connect to

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

Throws:

InvalidParameterException - null URL or server name

DataEngineRESTClient

public DataEngineRESTClient(String serverName,
                            String serverPlatformRootURL,
                            String userId,
                            String password)
                     throws InvalidParameterException

Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.

Parameters:

serverName - name of the server to connect to

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

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - null URL or server name

Method Detail

getExternalSourceName

public String getExternalSourceName()

Description copied from interface: DataEngineClient

Returns the name of the source system using data engine client

Specified by:

getExternalSourceName in interface DataEngineClient

Returns:

Source system name

setExternalSourceName

public void setExternalSourceName(String externalSourceName)

Description copied from interface: DataEngineClient

Sets external source system name using the data engine client

Specified by:

setExternalSourceName in interface DataEngineClient

Parameters:

externalSourceName - Source system name

getDeleteSemantic

public DeleteSemantic getDeleteSemantic()

setDeleteSemantic

public void setDeleteSemantic(DeleteSemantic deleteSemantic)

createOrUpdateProcess

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

Description copied from interface: DataEngineClient

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

Specified by:

createOrUpdateProcess in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

UserNotAuthorizedException - user not authorized to issue this request

deleteProcess

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

Description copied from interface: DataEngineClient

Delete a process

Specified by:

deleteProcess in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

createExternalDataEngine

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

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

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

deleteExternalDataEngine

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

Delete the external data engine

Specified by:

deleteExternalDataEngine in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

createOrUpdateSchemaType

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

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

PropertyServerException - problem accessing the property server

UserNotAuthorizedException - user not authorized to issue this request

deleteSchemaType

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

Delete the schema type

Specified by:

deleteSchemaType in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

createOrUpdatePortImplementation

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

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

Specified by:

createOrUpdatePortImplementation in interface DataEngineClient

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

deletePortImplementation

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

Delete the port implementation

Specified by:

deletePortImplementation in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

createOrUpdatePortAlias

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

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

Specified by:

createOrUpdatePortAlias in interface DataEngineClient

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

deletePortAlias

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

Delete the port alias

Specified by:

deletePortAlias in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

addProcessHierarchy

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

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

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

addLineageMappings

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

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

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertDatabase

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

Create or update the database entity

Specified by:

upsertDatabase in interface DataEngineClient

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

upsertDatabaseSchema

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

Create or update the database schema entity

Specified by:

upsertDatabaseSchema in interface DataEngineClient

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

upsertRelationalTable

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

Create or update the relational table entity

Specified by:

upsertRelationalTable in interface DataEngineClient

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

upsertDataFile

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

Create or update the data file entity

Specified by:

upsertDataFile in interface DataEngineClient

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

deleteDatabase

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

Delete the database

Specified by:

deleteDatabase in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteDatabaseSchema

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

Delete the database schema

Specified by:

deleteDatabaseSchema in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteRelationalTable

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

Delete the relational table

Specified by:

deleteRelationalTable in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteDataFile

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

Delete the data file

Specified by:

deleteDataFile in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteFolder

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

Delete the folder

Specified by:

deleteFolder in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteConnection

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

Delete the connection

Specified by:

deleteConnection in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteEndpoint

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

Delete the endpoint

Specified by:

deleteEndpoint in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

find

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

Find an entity

Specified by:

find in interface DataEngineClient

Parameters:

userId - the name of the calling user

findRequestBody - request body

Returns:

list of found entities

Throws:

ConnectorCheckedException - problem with the underlying connector (if used)

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

upsertTopic

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

Create or update the topic entity

Specified by:

upsertTopic in interface DataEngineClient

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

upsertEventType

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

Create or update the event type entity

Specified by:

upsertEventType in interface DataEngineClient

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

deleteTopic

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

Delete the topic

Specified by:

deleteTopic in interface DataEngineClient

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

PropertyServerException - problem accessing the property server

deleteEventType

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

Delete the event type

Specified by:

deleteEventType in interface DataEngineClient

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

PropertyServerException - problem accessing the property server