Package org.odpi.openmetadata.accessservices.securitymanager.api

Interface MetadataSourceInterface

public interface MetadataSourceInterface

MetadataSourceInterface is the interface used to define information about the third party technologies that an integration daemon is extracting metadata from. The these technologies are represented by a software server capability in open metadata.

Method Summary

Modifier and Type	Method	Description
String	createDatabaseManager(String userId, String externalSourceGUID, String externalSourceName, DatabaseManagerProperties databaseManagerProperties)	Create information about the integration daemon that is managing the acquisition of metadata from the security manager.
String	createFileManager(String userId, String externalSourceGUID, String externalSourceName, FileManagerProperties fileManagerProperties)	Create information about an application that manages a collection of data files.
String	createFileSystem(String userId, String externalSourceGUID, String externalSourceName, FileSystemProperties fileSystemProperties)	Create information about a File System that is being used to store data files.
String	getMetadataSourceGUID(String userId, String qualifiedName)	Retrieve the unique identifier of the software server capability that describes a metadata source.

Method Detail

createFileSystem

String createFileSystem(String userId,
                        String externalSourceGUID,
                        String externalSourceName,
                        FileSystemProperties fileSystemProperties)
                 throws InvalidParameterException,
                        UserNotAuthorizedException,
                        PropertyServerException

Create information about a File System that is being used to store data files.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

fileSystemProperties - description of the file system

Returns:

unique identifier of the file system's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createFileManager

String createFileManager(String userId,
                         String externalSourceGUID,
                         String externalSourceName,
                         FileManagerProperties fileManagerProperties)
                  throws InvalidParameterException,
                         UserNotAuthorizedException,
                         PropertyServerException

Create information about an application that manages a collection of data files.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

fileManagerProperties - description of the

Returns:

unique identifier of the file manager's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createDatabaseManager

String createDatabaseManager(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             DatabaseManagerProperties databaseManagerProperties)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Create information about the integration daemon that is managing the acquisition of metadata from the security manager. Typically this is Egeria's security manager proxy.

Parameters:

userId - calling user

externalSourceGUID - guid of the software server capability entity that represented the external source - null for local

externalSourceName - name of the software server capability entity that represented the external source

databaseManagerProperties - description of the integration daemon (specify qualified name at a minimum)

Returns:

unique identifier of the database management's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getMetadataSourceGUID

String getMetadataSourceGUID(String userId,
                             String qualifiedName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Retrieve the unique identifier of the software server capability that describes a metadata source. This could be a database manager, filesystem or file manager.

Parameters:

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the integration daemon's software server capability

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server