Package com.nt.udc.sidecar.connector

Interface AdminClientConnectorIfc

All Known Implementing Classes:
RSMAdminClientConnector
public interface AdminClientConnectorIfc
The AdminClientConnectorIfc interface defines methods for interacting with AdminServer, including registration, retrieval, and replication operations, as well as handling import tasks.

  • Method Details

    • putAndGetNodeManager

      Optional<NodeManagerDetails> putAndGetNodeManager(NodeManagerDetails nodeManagerDetails)
      Registers a Node Manager and returns the details of the registered Node Manager.
      Parameters:
      nodeManagerDetails - the details of the Node Manager to be registered
      Returns:
      an Optional<NodeManagerDetails> containing the details of the registered Node Manager, or empty if registration fails

    • getParentNodeManager

      Optional<NodeManagerDetails> getParentNodeManager(NodeManagerDetails nodeManagerDetails)
      Retrieves the parent Node Manager of the specified Node Manager.
      Parameters:
      nodeManagerDetails - the details of the Node Manager whose parent is to be retrieved
      Returns:
      an Optional<NodeManagerDetails> containing the details of the parent Node Manager, or empty if not found

    • getAllNodeManagers

      List<NodeManagerDetails> getAllNodeManagers()
      Retrieves a list of all Node Managers.
      Returns:
      a List<NodeManagerDetails> containing the details of all Node Managers

    • getNodeManagerDetailsByHostName

      Optional<NodeManagerDetails> getNodeManagerDetailsByHostName(String nodeManagerHostName)
      Retrieves the details of a Node Manager by its host name.
      Parameters:
      nodeManagerHostName - the host name of the Node Manager to be retrieved
      Returns:
      an Optional<NodeManagerDetails> containing the details of the Node Manager, or empty if not found

    • replicateNodeManager

      boolean replicateNodeManager(NodeManagerDetails parentNodeManager, NodeManagerDetails childNodeManager)
      Replicates a Node Manager from a parent Node Manager to a child Node Manager.
      Parameters:
      parentNodeManager - the details of the parent Node Manager
      childNodeManager - the details of the child Node Manager to be replicated
      Returns:
      true if replication is successful, otherwise false

    • uploadImportFiles

      Optional<ImportMappingRequest> uploadImportFiles(Path customizationFilePath, Path configurationFilePath)
      Uploads import files for customization and configuration and returns the import mapping request.
      Parameters:
      customizationFilePath - the path to the customization file
      configurationFilePath - the path to the configuration file
      Returns:
      an Optional<ImportMappingRequest> containing the import mapping request, or empty if upload fails

    • doImport

      Optional<ImportTaskStatusResponse.ImportTaskItem> doImport(ImportMappingRequest userMapping)
      Performs the import operation using the provided user mapping and returns the status of the import task.
      Parameters:
      userMapping - the import mapping request
      Returns:
      an Optional<ImportTaskStatusResponse.ImportTaskItem> containing the status of the import task, or empty if import fails

    • getImportTaskStatus

      Optional<ImportTaskStatusResponse> getImportTaskStatus(String importId, String taskId)
      Retrieves the status of an import task.
      Parameters:
      importId - the ID of the import
      taskId - the ID of the task
      Returns:
      an Optional<ImportTaskStatusResponse> containing the status of the import task, or empty if not found

    • scaleDownNodeManager

      boolean scaleDownNodeManager(String nodeManagerId, boolean preBackupCleanup)
      scaledown nodeManager with given Id
      Parameters:
      nodeManagerId - the ID of the NodeManager
      isPreBackupCleanup - - if true then all the preBackUp task will be done
      Returns:
      true if scaledown finishes successfully, else false