org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface RelationalDatabaseInfrastructureInterface

public interface RelationalDatabaseInfrastructureInterface

RelationalDatabaseInfrastructureInterface defines the client side interface for the Data Platform OMAS that is relevant for relational database infrastructure. It provides the ability to define and maintain the metadata about a database server.

Method Summary

Modifier and Type	Method and Description
String	addDatabaseEndpoint(String userId, String integrationDaemonGUID, String databaseServerGUID, EndpointProperties endpointProperties)
String	addDatabaseManager(String userId, String integrationDaemonGUID, DatabaseManagerProperties databaseManagerProperties)
String	addDatabaseServer(String userId, String integrationDaemonGUID, DatabaseServerProperties databaseServerProperties)
List<DatabaseServerProperties>	findDatabaseServersByHost(String userId, String hostName)
DatabaseServerProperties	getDatabaseServerByGUID(String userId, String databaseServerGUID)
DatabaseServerProperties	getDatabaseServerByName(String userId, String databaseServerName)
void	linkDatabaseEndpointToServer(String userId, String integrationDaemonGUID, String databaseEndpointGUID, String databaseServerGUID)
void	linkDatabaseManagerToServer(String userId, String integrationDaemonGUID, String databasePlatformGUID, String databaseServerGUID)
void	removeDatabaseServer(String userId, String databaseServerGUID)
void	updateDatabaseServerProperties(String userId, String databaseServerGUID, Map<String,String> updatedProperties)
void	updateDatabaseServerVendorProperties(String userId, String databaseServerGUID, Map<String,String> updatedProperties)

Method Detail

addDatabaseServer

String addDatabaseServer(String userId,
                         String integrationDaemonGUID,
                         DatabaseServerProperties databaseServerProperties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

addDatabaseManager

String addDatabaseManager(String userId,
                          String integrationDaemonGUID,
                          DatabaseManagerProperties databaseManagerProperties)
                   throws InvalidParameterException,
                          UserNotAuthorizedException,
                          PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

linkDatabaseManagerToServer

void linkDatabaseManagerToServer(String userId,
                                 String integrationDaemonGUID,
                                 String databasePlatformGUID,
                                 String databaseServerGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

addDatabaseEndpoint

String addDatabaseEndpoint(String userId,
                           String integrationDaemonGUID,
                           String databaseServerGUID,
                           EndpointProperties endpointProperties)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

linkDatabaseEndpointToServer

void linkDatabaseEndpointToServer(String userId,
                                  String integrationDaemonGUID,
                                  String databaseEndpointGUID,
                                  String databaseServerGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Throws:

InvalidParameterException

UserNotAuthorizedException

PropertyServerException

getDatabaseServerByGUID

DatabaseServerProperties getDatabaseServerByGUID(String userId,
                                                 String databaseServerGUID)

getDatabaseServerByName

DatabaseServerProperties getDatabaseServerByName(String userId,
                                                 String databaseServerName)

findDatabaseServersByHost

List<DatabaseServerProperties> findDatabaseServersByHost(String userId,
                                                         String hostName)

updateDatabaseServerProperties

void updateDatabaseServerProperties(String userId,
                                    String databaseServerGUID,
                                    Map<String,String> updatedProperties)

updateDatabaseServerVendorProperties

void updateDatabaseServerVendorProperties(String userId,
                                          String databaseServerGUID,
                                          Map<String,String> updatedProperties)

removeDatabaseServer

void removeDatabaseServer(String userId,
                          String databaseServerGUID)