Package org.opends.server.tools.tasks

Class TaskToolHelper

    • Field Detail

      • OPTION_LONG_COMPRESS

        public static final String OPTION_LONG_COMPRESS
        The value for the long option compress.
        See Also:
        Constant Field Values

      • OPTION_SHORT_COMPRESS

        public static final char OPTION_SHORT_COMPRESS
        The value for the short option compress.
        See Also:
        Constant Field Values

      • OPTION_SHORT_BACKEND_ID

        public static final Character OPTION_SHORT_BACKEND_ID
        The value for the "backendId" short option.

      • OPTION_LONG_TMP_DIRECTORY

        public static final String OPTION_LONG_TMP_DIRECTORY
        The value for the tmp directory long option.
        See Also:
        Constant Field Values

      • NOW

        public static final String NOW
        Magic value used to indicate that the user would like to schedule this operation to run immediately as a task as opposed to running the operation in the local VM.
        See Also:
        Constant Field Values

    • Constructor Detail

      • TaskToolHelper

        public TaskToolHelper​(com.forgerock.opendj.cli.Tool printer,
                      com.forgerock.opendj.cli.ArgumentParser argumentParser)
        Creates a new TaskToolHelper with the provided tool for printing the messages. Task options will be added at the global level to the provided argument parser.
        Parameters:
        printer - The tool used for printing the messages.
        argumentParser - The argument parser

      • TaskToolHelper

        public TaskToolHelper​(com.forgerock.opendj.cli.Tool printer,
                      com.forgerock.opendj.cli.ArgumentParser argumentParser,
                      com.forgerock.opendj.cli.SubCommand subCommand)
        Creates a new TaskToolHelper with the provided tool for printing the messages. Task options will be added to the provided sub-command.
        Parameters:
        printer - The tool used for printing the messages.
        argumentParser - The argument parser
        subCommand - The sub-command

    • Method Detail

      • shutdownBackends

        public static void shutdownBackends​(ServerContext serverContext)
        Shutdowns all backends.
        Parameters:
        serverContext - the server context

      • addAttributeIfArgumentPresent

        public static void addAttributeIfArgumentPresent​(Entry taskEntry,
                                                 String attrName,
                                                 com.forgerock.opendj.cli.Argument argument)
        Adds the attribute with the argument value to the task entry if the argument corresponding to the attribute has been provided on the command line.
        Parameters:
        taskEntry - The task Entry to update
        attrName - The attribute corresponding to the argument
        argument - The argument representing the attribute

      • addAttribute

        public static void addAttribute​(Entry taskEntry,
                                String attrName,
                                com.forgerock.opendj.cli.Argument argument)
        Adds the provided attribute with the argument value(s) to the provided task entry only if the argument has been provided on the command line.
        Parameters:
        taskEntry - The task Entry to update.
        attrName - A String representing the attribute name corresponding to the Argument.
        argument - The Argument containing the attribute value(s).

      • addTaskRelatedArgumentsToParser

        public TaskToolHelper addTaskRelatedArgumentsToParser​(boolean offlineModifiesServerFiles)
        Add all the task-related arguments to the constructor-supplied argument parser or sub command. This includes ldap client arguments to connect to a directory server, task arguments to customize the task execution and the offline argument to distinguish between the task mode and offline mode.
        Parameters:
        offlineModifiesServerFiles - Indicates whether the offline mode will modify server files
        Returns:
        this object to be able to chain method calls
        See Also:
        OFFLINE_DOES_NOT_MODIFY_SERVER_FILES, OFFLINE_MODIFIES_SERVER_FILES

      • addTaskRelatedArgumentsToParser

        public TaskToolHelper addTaskRelatedArgumentsToParser​(com.forgerock.opendj.cli.BooleanArgument offlineArgument)
        Add all the task-related arguments to the constructor-supplied argument parser or sub command. This includes ldap client arguments to connect to a directory server, task arguments to customize the task execution and the provided offline argument to distinguish between the task mode and offline mode.
        Parameters:
        offlineArgument - the offline argument
        Returns:
        this object to be able to chain method calls
        See Also:
        OFFLINE_DOES_NOT_MODIFY_SERVER_FILES, OFFLINE_MODIFIES_SERVER_FILES

      • validateTaskRelatedArguments

        public void validateTaskRelatedArguments​(boolean isEmbedded)
                                  throws com.forgerock.opendj.cli.ClientException
        Validates the task-related arguments and throw an exception if the user-provided values are invalid.
        Parameters:
        isEmbedded - Whether the tool is embedded.
        Throws:
        com.forgerock.opendj.cli.ClientException - If the user provided values for task-related argument are invalid.

      • isOffline

        public boolean isOffline()
        Indicates whether the offline argument was provided.
        Returns:
        whether the offline argument was provided.

      • process

        public com.forgerock.opendj.cli.ReturnCode process​(TaskCommand taskCommand)
                                            throws com.forgerock.opendj.cli.ClientException
        Process locally or run a task depending on whether the offline argument was provided. The task will be run according to the user provided task-related arguments.
        Parameters:
        taskCommand - the command that should be executed.
        Returns:
        the return code.
        Throws:
        com.forgerock.opendj.cli.ClientException - If there is a problem when running the task.