Class DataEngineConnectionAndEndpointHandler

java.lang.Object
org.odpi.openmetadata.accessservices.dataengine.server.handlers.DataEngineConnectionAndEndpointHandler

public class DataEngineConnectionAndEndpointHandler extends Object
DataEngineConnectionAndEndpointHandler manages Connection and Endpoint objects from the property server. It runs server-side in the DataEngine OMAS and creates Connection and Endpoint entities with wire relationships through the OMRSRepositoryConnector.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
  • Constructor Summary

    Constructors
    Constructor
    Description
    DataEngineConnectionAndEndpointHandler(org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName, DataEngineCommonHandler dataEngineCommonHandler, org.odpi.openmetadata.commonservices.generichandlers.ConnectionHandler<org.odpi.openmetadata.accessservices.dataengine.model.Connection> connectionHandler, org.odpi.openmetadata.commonservices.generichandlers.EndpointHandler<org.odpi.openmetadata.accessservices.dataengine.model.Endpoint> endpointHandler, org.odpi.openmetadata.commonservices.generichandlers.ConnectorTypeHandler<org.odpi.openmetadata.accessservices.dataengine.model.ConnectorType> connectorTypeHandler)
    Construct the handler information needed to interact with the repository services
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    removeConnection(String userId, String connectionGUID, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic, String externalSourceName, String externalSourceGUID)
    Remove the connection
    void
    removeEndpoint(String userId, String endpointGUID, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic, String externalSourceName, String externalSourceGUID)
    Remove the endpoint
    void
    upsertConnectionAndEndpoint(String assetQualifiedName, String assetGUID, String assetTypeName, String protocol, String networkAddress, String externalSourceGUID, String externalSourceName, String userID)
    Constructs an Endpoint linked to a Connection, which in turn links it to provided asset

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

  • Constructor Details

    • DataEngineConnectionAndEndpointHandler

      public DataEngineConnectionAndEndpointHandler(org.odpi.openmetadata.commonservices.ffdc.InvalidParameterHandler invalidParameterHandler, org.odpi.openmetadata.repositoryservices.connectors.stores.metadatacollectionstore.repositoryconnector.OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName, DataEngineCommonHandler dataEngineCommonHandler, org.odpi.openmetadata.commonservices.generichandlers.ConnectionHandler<org.odpi.openmetadata.accessservices.dataengine.model.Connection> connectionHandler, org.odpi.openmetadata.commonservices.generichandlers.EndpointHandler<org.odpi.openmetadata.accessservices.dataengine.model.Endpoint> endpointHandler, org.odpi.openmetadata.commonservices.generichandlers.ConnectorTypeHandler<org.odpi.openmetadata.accessservices.dataengine.model.ConnectorType> connectorTypeHandler)
      Construct the handler information needed to interact with the repository services
      Parameters:
      invalidParameterHandler - handler for managing parameter errors
      repositoryHelper - provides utilities for manipulating the repository services objects
      serviceName - service name
      serverName - server name
      dataEngineCommonHandler - provides common Data Engine OMAS utilities
      connectionHandler - provides utilities specific for manipulating Connection
      endpointHandler - provides utilities specific for manipulating Endpoint
      connectorTypeHandler - provides utilities specific for manipulating ConnectorType
  • Method Details

    • upsertConnectionAndEndpoint

      public void upsertConnectionAndEndpoint(String assetQualifiedName, String assetGUID, String assetTypeName, String protocol, String networkAddress, String externalSourceGUID, String externalSourceName, String userID) throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Constructs an Endpoint linked to a Connection, which in turn links it to provided asset
      Parameters:
      assetQualifiedName - asset qualified name
      assetGUID - asset GUID
      assetTypeName - asset type name
      protocol - property of Endpoint
      networkAddress - property of Endpoint
      externalSourceGUID - external source guid
      externalSourceName - external source name
      userID - user id
      Throws:
      org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - if invalid parameters
      org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - if errors in repository
      org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - if user not authorized
    • removeConnection

      public void removeConnection(String userId, String connectionGUID, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic, String externalSourceName, String externalSourceGUID) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Remove the connection
      Parameters:
      userId - the name of the calling user
      connectionGUID - unique identifier of the connection to be removed
      deleteSemantic - the delete semantic
      externalSourceName - the external data engine
      externalSourceGUID - the external data engine GUID
      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.
    • removeEndpoint

      public void removeEndpoint(String userId, String endpointGUID, org.odpi.openmetadata.accessservices.dataengine.model.DeleteSemantic deleteSemantic, String externalSourceName, String externalSourceGUID) throws org.odpi.openmetadata.repositoryservices.ffdc.exception.FunctionNotSupportedException, org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException
      Remove the endpoint
      Parameters:
      userId - the name of the calling user
      endpointGUID - unique identifier of the endpoint to be removed
      deleteSemantic - the delete semantic
      externalSourceName - the external data engine
      externalSourceGUID - the external data engine GUID
      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.