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

Class DataEngineRegistrationHandler

java.lang.Object

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

public class DataEngineRegistrationHandler
extends Object

DataEngineRegistrationHandler manages SoftwareServerCapability objects from external data engines. It runs server-side in the DataEngine OMAS and creates software server capability entities through the OMRSRepositoryConnector.

Constructor Summary

Constructors

Constructor and Description
DataEngineRegistrationHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper) Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method and Description
String	createExternalDataEngine(String userId, SoftwareServerCapability softwareServerCapability) Create the software server capability entity from an external data engine
String	createExternalDataEngine(String userId, String qualifiedName, String name, String description, String type, String version, String patchLevel, String source) Create the software server capability entity from an external data engine
String	getExternalDataEngineByQualifiedName(String userId, String qualifiedName) Return the guid of a software server capability entity from an external data engine

Methods inherited from class java.lang.Object

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

Constructor Detail

DataEngineRegistrationHandler

public DataEngineRegistrationHandler(String serviceName,
                                     String serverName,
                                     InvalidParameterHandler invalidParameterHandler,
                                     RepositoryHandler repositoryHandler,
                                     OMRSRepositoryHelper repositoryHelper)

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

repositoryHandler - manages calls to the repository services

repositoryHelper - provides utilities for manipulating the repository services objects

Method Detail

createExternalDataEngine

public String createExternalDataEngine(String userId,
                                       String qualifiedName,
                                       String name,
                                       String description,
                                       String type,
                                       String version,
                                       String patchLevel,
                                       String source)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Create the software server capability entity from an external data engine

Parameters:

userId - the name of the calling user

qualifiedName - the qualifiedName name of the server

name - the name of the server

description - the description of the server

type - the type of the server

version - the version of the server

patchLevel - the patch level of the server

source - the source of the server

Returns:

unique identifier of the external data engine in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

createExternalDataEngine

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

Create the software server capability entity from an external data engine

Parameters:

userId - the name of the calling user

softwareServerCapability - the entity of external data engine

Returns:

unique identifier of the external data engine in the repository

Throws:

InvalidParameterException - the bean properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getExternalDataEngineByQualifiedName

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

Return the guid of a software server capability entity from an external data engine

Parameters:

userId - identifier of calling user

qualifiedName - qualified name of the external data engine

Returns:

the guid of the the external data engine

Throws:

InvalidParameterException - one of the parameters is null or invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem retrieving the discovery engine definition