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

Class DataEngineCollectionHandler

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineCollectionHandler
public class DataEngineCollectionHandler extends Object
DataEngineCollectionHandler manages collection objects. It runs server-side in the DataEngine OMAS and creates and retrieves collections entities through the OMRSRepositoryConnector.

  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineCollectionHandler(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.OpenMetadataAPIGenericHandler<org.odpi.openmetadata.accessservices.dataengine.model.Collection> collectionOpenMetadataAPIGenericHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addCollectionMembershipRelationship(String userId, String processGUID, String collectionGUID, String externalSourceName)
    Create CollectionMembership relationships between a Process asset and a Collection.
    String
    createCollection(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Collection collection, String externalSourceName)
    Create the schema type entity, with the corresponding schema attributes and relationships if it doesn't exist or updates the existing one.
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findCollectionEntity(String userId, String qualifiedName)
    Find out if the Transformation Project object is already stored in the repository as a Collection.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DataEngineCollectionHandler

      public DataEngineCollectionHandler(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.OpenMetadataAPIGenericHandler<org.odpi.openmetadata.accessservices.dataengine.model.Collection> collectionOpenMetadataAPIGenericHandler, DataEngineRegistrationHandler dataEngineRegistrationHandler, DataEngineCommonHandler dataEngineCommonHandler)
      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
      dataEngineRegistrationHandler - provides calls for retrieving external data engine guid
      dataEngineCommonHandler - provides utilities for manipulating entities
      collectionOpenMetadataAPIGenericHandler - helps building model for creating Collection metadata associated with Process assets

  • Method Details

    • createCollection

      public String createCollection(String userId, org.odpi.openmetadata.accessservices.dataengine.model.Collection collection, 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
      collection - the collection 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

    • findCollectionEntity

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findCollectionEntity(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 Transformation Project object is already stored in the repository as a Collection. It uses the fully qualified name to retrieve the entity
      Parameters:
      userId - the name of the calling user
      qualifiedName - the qualifiedName name of the process 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

    • addCollectionMembershipRelationship

      public void addCollectionMembershipRelationship(String userId, String processGUID, String collectionGUID, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Create CollectionMembership relationships between a Process asset and a Collection. Verifies that the relationship is not present before creating it
      Parameters:
      userId - the name of the calling user
      processGUID - the unique identifier of the process
      collectionGUID - the unique identifier of the collection
      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