Package 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 Engine objects from external data engines. It runs server-side in the DataEngine OMAS and creates engine entities through the SoftwareCapabilityHandler.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SYNC_DATES_BY_KEY

Constructor Summary

Constructors

Constructor

Description

DataEngineRegistrationHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, org.odpi.openmetadata.commonservices.generichandlers.SoftwareCapabilityHandler<org.odpi.openmetadata.accessservices.dataengine.model.Engine> softwareServerCapabilityHandler, ClockService clockService)

Construct the handler information needed to interact with the repository services

Method Summary

Modifier and Type	Method	Description
String	getExternalDataEngine(String userId, String qualifiedName)	Return the guid of an engine entity from an external data engine
org.odpi.openmetadata.accessservices.dataengine.model.ProcessingState	getProcessingStateClassification(String userId, String externalSourceName)
void	removeExternalDataEngine(String userId, String qualifiedName, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
String	upsertExternalDataEngine(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Engine engine)	Create the engine entity from an external data engine
void	upsertProcessingStateClassification(String userId, org.odpi.openmetadata.accessservices.dataengine.model.ProcessingState processingState, String externalSourceName)

Methods inherited from class java.lang.Object

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

Field Details

SYNC_DATES_BY_KEY

public static final String SYNC_DATES_BY_KEY

See Also:

• Constant Field Values

Constructor Details

DataEngineRegistrationHandler

public DataEngineRegistrationHandler(String serviceName,
 String serverName,
 org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler,
 org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper,
 org.odpi.openmetadata.commonservices.generichandlers.SoftwareCapabilityHandler<org.odpi.openmetadata.accessservices.dataengine.model.Engine> softwareServerCapabilityHandler,
 ClockService clockService)

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

repositoryHelper - provides utilities for manipulating the repository services objects

softwareServerCapabilityHandler - handler for the creation of engine objects

Method Details

upsertExternalDataEngine

public String upsertExternalDataEngine(String userId,
 org.odpi.openmetadata.accessservices.dataengine.model.Engine engine)
                                throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Create the engine entity from an external data engine

Parameters:

userId - the name of the calling user

engine - the entity of external data engine

Returns:

unique identifier of the external data engine in the repository

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - the bean properties are invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem accessing the property server

getExternalDataEngine

public String getExternalDataEngine(String userId,
 String qualifiedName)
                             throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Return the guid of an engine 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 external data engine

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is null or invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - user not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - problem retrieving the discovery engine definition

removeExternalDataEngine

public void removeExternalDataEngine(String userId,
 String qualifiedName,
 String externalSourceName,
 org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
                              throws org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException

Throws:

org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException

upsertProcessingStateClassification

public void upsertProcessingStateClassification(String userId,
 org.odpi.openmetadata.accessservices.dataengine.model.ProcessingState processingState,
 String externalSourceName)
                                         throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

getProcessingStateClassification

public org.odpi.openmetadata.accessservices.dataengine.model.ProcessingState getProcessingStateClassification(String userId,
 String externalSourceName)
                                                                                                       throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException

Throws:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException