Package org.odpi.openmetadata.accessservices.datamanager.client

Class MetadataSourceClient

java.lang.Object

org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

org.odpi.openmetadata.accessservices.datamanager.client.MetadataSourceClient

All Implemented Interfaces:

MetadataSourceInterface

public class MetadataSourceClient
extends DataManagerBaseClient
implements MetadataSourceInterface

MetadataSourceClient is the client for setting up the SoftwareServerCapabilities that represent metadata sources.

Constructor Summary

Constructors

Constructor	Description
MetadataSourceClient(String serverName, String serverPlatformURLRoot)	Create a new client with no authentication embedded in the HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Create a new client that passes userId and password in each HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Create a new client that passes userId and password in each HTTP request.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, DataManagerRESTClient restClient, int maxPageSize)	Create a new client that is to be used within an OMAG Server.
MetadataSourceClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Create a new client with no authentication embedded in the HTTP request.

Method Summary

Modifier and Type	Method	Description
String	createAPIManager(String userId, String externalSourceGUID, String externalSourceName, APIManagerProperties apiManagerProperties)	Create information about the component that manages APIs.
String	createApplication(String userId, String externalSourceGUID, String externalSourceName, ApplicationProperties applicationProperties)	Create information about an application.
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 data manager.
String	createDataProcessingEngine(String userId, String externalSourceGUID, String externalSourceName, DataProcessingEngineProperties engineProperties)	Create information about a data processing engine - set up typeName in the properties to create subtypes such as ReportingEngine, WorkflowEngine, AnalyticsEngine, DataMovementEngine or DataVirtualizationEngine.
String	createEventBroker(String userId, String externalSourceGUID, String externalSourceName, EventBrokerProperties eventBrokerProperties)	Create information about the integration daemon that is managing the acquisition of metadata from the data 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 data manager.

Methods inherited from class org.odpi.openmetadata.accessservices.datamanager.client.DataManagerBaseClient

removeReferenceable

Methods inherited from class java.lang.Object

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

Constructor Details

MetadataSourceClient

public MetadataSourceClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                     throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

MetadataSourceClient

public MetadataSourceClient(String serverName,
 String serverPlatformURLRoot)
                     throws InvalidParameterException

Create a new client with no authentication embedded in the HTTP request.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

MetadataSourceClient

public MetadataSourceClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                     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

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

auditLog - logging destination

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

MetadataSourceClient

public MetadataSourceClient(String serverName,
 String serverPlatformURLRoot,
 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

serverPlatformURLRoot - the network address of the server running the OMAS REST services

userId - caller's userId embedded in all HTTP requests

password - caller's userId embedded in all HTTP requests

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

MetadataSourceClient

public MetadataSourceClient(String serverName,
 String serverPlatformURLRoot,
 DataManagerRESTClient restClient,
 int maxPageSize)
                     throws InvalidParameterException

Create a new client that is to be used within an OMAG Server.

Parameters:

serverName - name of the server to connect to

serverPlatformURLRoot - the network address of the server running the OMAS REST services

restClient - pre-initialized REST client

maxPageSize - pre-initialized parameter limit

Throws:

InvalidParameterException - there is a problem with the information about the remote OMAS

Method Details

createAPIManager

public String createAPIManager(String userId,
 String externalSourceGUID,
 String externalSourceName,
 APIManagerProperties apiManagerProperties)
                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create information about the component that manages APIs.

Specified by:

createAPIManager in interface MetadataSourceInterface

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

apiManagerProperties - description of the API manager (specify qualified name at a minimum)

Returns:

unique identifier of the API 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

public 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 data manager. Typically, this is Egeria's data manager integrator OMIS.

Specified by:

createDatabaseManager in interface MetadataSourceInterface

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 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

createEventBroker

public String createEventBroker(String userId,
 String externalSourceGUID,
 String externalSourceName,
 EventBrokerProperties eventBrokerProperties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

Specified by:

createEventBroker in interface MetadataSourceInterface

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

eventBrokerProperties - description of the event broker (specify qualified name at a minimum)

Returns:

unique identifier of the event broker'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

createFileSystem

public 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.

Specified by:

createFileSystem in interface MetadataSourceInterface

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

public 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.

Specified by:

createFileManager in interface MetadataSourceInterface

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

createApplication

public String createApplication(String userId,
 String externalSourceGUID,
 String externalSourceName,
 ApplicationProperties applicationProperties)
                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create information about an application.

Specified by:

createApplication in interface MetadataSourceInterface

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

applicationProperties - description of the application (specify qualified name at a minimum)

Returns:

unique identifier of the application'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

createDataProcessingEngine

public String createDataProcessingEngine(String userId,
 String externalSourceGUID,
 String externalSourceName,
 DataProcessingEngineProperties engineProperties)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Create information about a data processing engine - set up typeName in the properties to create subtypes such as ReportingEngine, WorkflowEngine, AnalyticsEngine, DataMovementEngine or DataVirtualizationEngine.

Specified by:

createDataProcessingEngine in interface MetadataSourceInterface

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

engineProperties - description of the engine (specify qualified name at a minimum)

Returns:

unique identifier of the engine'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

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

Retrieve the unique identifier of the data manager.

Specified by:

getMetadataSourceGUID in interface MetadataSourceInterface

Parameters:

userId - calling user

qualifiedName - unique name of the integration daemon

Returns:

unique identifier of the data 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