Package org.opends.server.tools.tasks

Interface TaskToolHelper.TaskCommand

All Known Implementing Classes:
ExportLdif, ImportLdif, RebuildIndex
Enclosing class:
TaskToolHelper
public static interface TaskToolHelper.TaskCommand
This interface must be implemented by tool commands or sub-commands that offer the possibility to run in offline mode or via a Directory Server task.

  • Method Details

    • validateArguments

      default void validateArguments() throws com.forgerock.opendj.cli.ClientException
      Validates the argument values before running locally or sending a task to the server.
      Throws:
      com.forgerock.opendj.cli.ClientException - If the user provided arguments are not valid.

    • processLocal

      com.forgerock.opendj.cli.ReturnCode processLocal() throws com.forgerock.opendj.cli.ClientException
      Runs the command in offline mode.
      Returns:
      the return code.
      Throws:
      com.forgerock.opendj.cli.ClientException - If an error occurs.

    • getTaskImplementation

      TaskScheduleInformation.TaskImplementation getTaskImplementation()
      Returns the task implementation.
      Returns:
      the task implementation