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

Class DataEngineSchemaTypeHandler

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineSchemaTypeHandler
public class DataEngineSchemaTypeHandler extends Object
DataEngineSchemaTypeHandler manages schema types objects from the property server. It runs server-side in the DataEngine OMAS and creates and retrieves schema type entities through the OMRSRepositoryConnector.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineSchemaTypeHandler(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.SchemaTypeHandler<org.odpi.openmetadata.accessservices.dataengine.model.SchemaType> schemaTypeHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler, DataEngineSchemaAttributeHandler dataEngineSchemaAttributeHandler)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addDataFlowRelationship(String userId, String dataSupplierQualifiedName, String dataConsumerQualifiedName, String externalSourceName, String formula, String description)
    Create DataFlow relationship between two entities
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findSchemaTypeEntity(String userId, String qualifiedName)
    Find out if the SchemaType object is already stored in the repository.
    void
    removeSchemaType(String userId, String schemaTypeGUID, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
    Remove the schema type with the associated schema attributes
    String
    upsertSchemaType(String userId, org.odpi.openmetadata.accessservices.dataengine.model.SchemaType schemaType, String anchorGUID, String externalSourceName)
    Create the schema type entity, with the corresponding schema attributes and relationships if it doesn't exist or updates the existing one.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DataEngineSchemaTypeHandler

      public DataEngineSchemaTypeHandler(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.SchemaTypeHandler<org.odpi.openmetadata.accessservices.dataengine.model.SchemaType> schemaTypeHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler, DataEngineSchemaAttributeHandler dataEngineSchemaAttributeHandler)
      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
      schemaTypeHandler - handler for managing schema elements in the metadata repositories
      dataEngineRegistrationHandler - provides calls for retrieving external data engine guid
      dataEngineCommonHandler - provides utilities for manipulating entities
      dataEngineSchemaAttributeHandler - provides utilities for manipulating schema attributes

  • Method Details

    • upsertSchemaType

      public String upsertSchemaType(String userId, org.odpi.openmetadata.accessservices.dataengine.model.SchemaType schemaType, String anchorGUID, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Create the schema type entity, with the corresponding schema attributes and relationships if it doesn't exist or updates the existing one.
      Parameters:
      userId - the name of the calling user
      schemaType - the schema type values
      externalSourceName - the unique name of the external source
      Returns:
      unique identifier of the schema type 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

    • findSchemaTypeEntity

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findSchemaTypeEntity(String userId, String qualifiedName) 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 SchemaType object 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 schema type to be searched
      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

    • addDataFlowRelationship

      public void addDataFlowRelationship(String userId, String dataSupplierQualifiedName, String dataConsumerQualifiedName, String externalSourceName, String formula, String description) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create DataFlow relationship between two entities
      Parameters:
      userId - the name of the calling user
      dataSupplierQualifiedName - the qualified name of the data supplier entity
      dataConsumerQualifiedName - the qualified name of the data consumer entity
      externalSourceName - the unique name of the external source
      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

    • removeSchemaType

      public void removeSchemaType(String userId, String schemaTypeGUID, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException
      Remove the schema type with the associated schema attributes
      Parameters:
      userId - the name of the calling user
      schemaTypeGUID - the unique identifier of the schema type
      externalSourceName - the external data engine
      deleteSemantic - the delete semantic
      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
      org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException - the repository does not support this call.