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

Class DataEngineCommonHandler

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineCommonHandler
public class DataEngineCommonHandler extends Object
DataEngineCommonHandler manages objects from the property server. It runs server-side in the DataEngine OMAS and creates port entities with wire relationships through the OMRSRepositoryConnector.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineCommonHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<org.odpi.openmetadata.accessservices.dataengine.model.Referenceable> genericHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, DataEngineRegistrationHandler dataEngineRegistrationHandler, ClockService clockService)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findEntity(String userId, String qualifiedName, String entityTypeName)
    Find out if the entity is already stored in the repository.
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    getEntityDetails(String userId, String entityDetailGUID, String entityTypeName)
    Fetch the entity using the identifier and the type name.
    void
    throwEntityNotDeletedException(org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineErrorCode errorCode, String methodName, String... params)
     
    void
    throwInvalidParameterException(org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineErrorCode errorCode, String methodName, String... params)
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DataEngineCommonHandler

      public DataEngineCommonHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler<org.odpi.openmetadata.accessservices.dataengine.model.Referenceable> genericHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, DataEngineRegistrationHandler dataEngineRegistrationHandler, 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
      genericHandler - manages calls to the repository services
      repositoryHelper - provides utilities for manipulating the repository services objects
      dataEngineRegistrationHandler - provides calls for retrieving external data engine guid

  • Method Details

    • findEntity

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findEntity(String userId, String qualifiedName, String entityTypeName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Find out if the entity is already stored in the repository. It uses the fully qualified name to retrieve the entity
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualifiedName name of the entity to be searched
      entityTypeName - the type name of the entity
      Returns:
      optional with entity details if found, empty optional if not found
      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

    • getEntityDetails

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> getEntityDetails(String userId, String entityDetailGUID, String entityTypeName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Fetch the entity using the identifier and the type name. It uses the unique identifier to retrieve the entity
      Parameters:
      userId - the user identifier
      entityDetailGUID - the entity unique identifier
      entityTypeName - the entity type name
      Returns:
      optional with entity details if found, empty optional if not found
      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 entity.

    • throwInvalidParameterException

      public void throwInvalidParameterException(org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineErrorCode errorCode, String methodName, String... params) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException

    • throwEntityNotDeletedException

      public void throwEntityNotDeletedException(org.odpi.openmetadata.accessservices.dataengine.ffdc.DataEngineErrorCode errorCode, String methodName, String... params) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotDeletedException
      Throws:
      org.odpi.openmetadata.repositoryservices.ffdc.exception.EntityNotDeletedException