Package org.odpi.openmetadata.accessservices.dataengine.server.handlers

Class DataEngineRelationalDataHandler

java.lang.Object

org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineRelationalDataHandler

public class DataEngineRelationalDataHandler
extends Object

DataEngineRelationalDataHandler manages Databases and RelationalTables objects from the property server. It runs server-side in the DataEngine OMAS and creates entities and relationships through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor

Description

DataEngineRelationalDataHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RelationalDataHandler<Database,DatabaseSchema,RelationalTable,RelationalTable,RelationalColumn,SchemaType> relationalDataHandler, AssetHandler<DatabaseSchema> databaseSchemaAssetHandler, DataEngineRegistrationHandler registrationHandler, DataEngineCommonHandler dataEngineCommonHandler, DataEngineConnectionAndEndpointHandler dataEngineConnectionAndEndpointHandler)

Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
void	removeDatabase(String userId, String databaseGUID, String externalSourceName, DeleteSemantic deleteSemantic)	Remove the database
void	removeDatabaseSchema(String userId, String databaseSchemaGUID, String externalSourceName, DeleteSemantic deleteSemantic)	Removes the database schema
void	removeRelationalTable(String userId, String relationalTableGUID, String externalSourceName, DeleteSemantic deleteSemantic)	Remove the relational table
String	upsertDatabase(String userId, Database database, String externalSourceName)	Create or update the database and the inside entities, if any (a database schema and relational tables)
String	upsertDatabaseSchema(String userId, String databaseGUID, DatabaseSchema databaseSchema, String externalSourceName)	Create or update the database schema
String	upsertRelationalTable(String userId, String databaseSchemaQualifiedName, RelationalTable relationalTable, String externalSourceName)	Create or update the relational table

Methods inherited from class java.lang.Object

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

Constructor Details

DataEngineRelationalDataHandler

public DataEngineRelationalDataHandler(String serviceName,
 String serverName,
 InvalidParameterHandler invalidParameterHandler,
 RelationalDataHandler<Database,DatabaseSchema,RelationalTable,RelationalTable,RelationalColumn,SchemaType> relationalDataHandler,
 AssetHandler<DatabaseSchema> databaseSchemaAssetHandler,
 DataEngineRegistrationHandler registrationHandler,
 DataEngineCommonHandler dataEngineCommonHandler,
 DataEngineConnectionAndEndpointHandler dataEngineConnectionAndEndpointHandler)

Construct the handler information needed to interact with the repository services

Parameters:

serviceName - name of this service

serverName - name of the local server

invalidParameterHandler - handler for managing parameter errors

relationalDataHandler - provides utilities for manipulating the repository services assets

databaseSchemaAssetHandler - provides utilities for manipulating database schema assets

dataEngineCommonHandler - provides utilities for manipulating entities

registrationHandler - creates engine entities

dataEngineConnectionAndEndpointHandler - provides utilities specific for manipulating Connections and Endpoints

Method Details

upsertDatabase

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

Create or update the database and the inside entities, if any (a database schema and relational tables)

Parameters:

userId - the name of the calling user

database - the values of the database

externalSourceName - the unique name of the external source

Returns:

unique identifier of the 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,
 String databaseGUID,
 DatabaseSchema databaseSchema,
 String externalSourceName)
                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create or update the database schema

Parameters:

userId - the name of the calling user

databaseGUID - the unique identifier of the database

databaseSchema - the values of the database schema

externalSourceName - the unique name of the external source

Returns:

database schema GUID

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,
 String databaseSchemaQualifiedName,
 RelationalTable relationalTable,
 String externalSourceName)
                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Create or update the relational table

Parameters:

userId - the name of the calling user

databaseSchemaQualifiedName - the database qualified name

relationalTable - the values of the relational table

externalSourceName - the unique name of the external source

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

removeDatabase

public void removeDatabase(String userId,
 String databaseGUID,
 String externalSourceName,
 DeleteSemantic deleteSemantic)
                    throws FunctionNotSupportedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove the database

Parameters:

userId - the name of the calling user

databaseGUID - unique identifier of the database to be removed

externalSourceName - the external data engine name

deleteSemantic - the delete semantic

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

FunctionNotSupportedException - the repository does not support this call.

removeRelationalTable

public void removeRelationalTable(String userId,
 String relationalTableGUID,
 String externalSourceName,
 DeleteSemantic deleteSemantic)
                           throws FunctionNotSupportedException,
InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Remove the relational table

Parameters:

userId - the name of the calling user

relationalTableGUID - unique identifier of the relational table to be removed

externalSourceName - the external data engine name

deleteSemantic - the delete semantic

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

FunctionNotSupportedException - the repository does not support this call.

removeDatabaseSchema

public void removeDatabaseSchema(String userId,
 String databaseSchemaGUID,
 String externalSourceName,
 DeleteSemantic deleteSemantic)
                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException,
FunctionNotSupportedException

Removes the database schema

Parameters:

userId - the name of the calling user

databaseSchemaGUID - unique identifier of the database schema to be removed

externalSourceName - the external data engine name

deleteSemantic - the delete semantic

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

FunctionNotSupportedException - the repository does not support this call.