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

Class DataEnginePortHandler

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEnginePortHandler
public class DataEnginePortHandler extends Object
PortHandler manages Port 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
    DataEnginePortHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, DataEngineCommonHandler dataEngineCommonHandler, org.odpi.openmetadata.commonservices.generichandlers.PortHandler<org.odpi.openmetadata.accessservices.dataengine.model.Port> portHandler, DataEngineRegistrationHandler registrationHandler)
    Construct the handler information needed to interact with the repository services

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addPortSchemaRelationship(String userId, String portGUID, String schemaTypeGUID, String externalSourceName)
    Create a PortSchema relationship between a Port and the corresponding SchemaType.
    String
    createPortImplementation(String userId, org.odpi.openmetadata.accessservices.dataengine.model.PortImplementation port, String processGUID, String externalSourceName)
    Create the port implementation attached to a process.
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findPortImplementationEntity(String userId, String qualifiedName)
    Find out if the PortImplementation object is already stored in the repository.
    Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail>
    findSchemaTypeForPort(String userId, String portGUID)
    Retrieve the schema type that is linked to the port
    void
    removePort(String userId, String portGUID, String externalSourceName, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic)
    Remove the port
    void
    updatePortImplementation(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail originalPortEntity, org.odpi.openmetadata.accessservices.dataengine.model.PortImplementation port, String externalSourceName)
    Update the port implementation

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • DataEnginePortHandler

      public DataEnginePortHandler(String serviceName, String serverName, org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, DataEngineCommonHandler dataEngineCommonHandler, org.odpi.openmetadata.commonservices.generichandlers.PortHandler<org.odpi.openmetadata.accessservices.dataengine.model.Port> portHandler, DataEngineRegistrationHandler registrationHandler)
      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
      dataEngineCommonHandler - provides utilities for manipulating entities
      portHandler - provides utilities for manipulating the repository services ports
      registrationHandler - provides utilities for manipulating engine entities

  • Method Details

    • createPortImplementation

      public String createPortImplementation(String userId, org.odpi.openmetadata.accessservices.dataengine.model.PortImplementation port, String processGUID, 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 the port implementation attached to a process.
      Parameters:
      userId - the name of the calling user
      port - the port implementation values
      processGUID - the unique identifier of the process
      externalSourceName - the unique name of the external source
      Returns:
      unique identifier of the port implementation 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

    • updatePortImplementation

      public void updatePortImplementation(String userId, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail originalPortEntity, org.odpi.openmetadata.accessservices.dataengine.model.PortImplementation port, String externalSourceName) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Update the port implementation
      Parameters:
      userId - the name of the calling user
      originalPortEntity - the created port entity
      port - the port implementation new values
      externalSourceName - the external data engine
      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

    • addPortSchemaRelationship

      public void addPortSchemaRelationship(String userId, String portGUID, String schemaTypeGUID, 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 a PortSchema relationship between a Port and the corresponding SchemaType. Verifies that the relationship is not present before creating it
      Parameters:
      userId - the name of the calling user
      portGUID - the unique identifier of the port
      schemaTypeGUID - the unique identifier of the schema type
      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

    • findSchemaTypeForPort

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findSchemaTypeForPort(String userId, String portGUID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException
      Retrieve the schema type that is linked to the port
      Parameters:
      userId - the name of the calling user
      portGUID - the unique identifier of the port
      Returns:
      retrieved entity or an empty optional
      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

    • removePort

      public void removePort(String userId, String portGUID, 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 port
      Parameters:
      userId - the name of the calling user
      portGUID - unique identifier of the port to be removed
      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.

    • findPortImplementationEntity

      public Optional<org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.properties.instances.EntityDetail> findPortImplementationEntity(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
      Find out if the PortImplementation 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 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