org.opends.server.tools

Class RebuildIndex

java.lang.Object

com.forgerock.opendj.cli.Tool

org.opends.server.tools.tasks.TaskTool

org.opends.server.tools.RebuildIndex

All Implemented Interfaces:

Closeable, AutoCloseable, TaskScheduleInformation

public class RebuildIndex
extends TaskTool

This program provides a utility to rebuild the contents of the indexes of a Directory Server backend. This will be a process that is intended to run separate from Directory Server and not internally within the server process (e.g., via the tasks interface).

Nested Class Summary

Nested classes/interfaces inherited from class com.forgerock.opendj.cli.Tool

com.forgerock.opendj.cli.Tool.Style

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTION_LONG_REBUILD_ALL The value for the rebuild all long option.

Fields inherited from class org.opends.server.tools.tasks.TaskTool

canInitializeServer, NOW, OPTION_LONG_COMPRESS, OPTION_LONG_TMP_DIRECTORY, OPTION_SHORT_BACKEND_ID, OPTION_SHORT_COMPRESS

Constructor Summary

Constructors

Constructor and Description
RebuildIndex(OutputStream out, OutputStream err, boolean canInitializeServer) Creates a new RebuildIndex with the provided output and error OutputStreams.

Method Summary

Modifier and Type	Method and Description
void	addTaskAttributes(Entry taskEntry) Adds utility specific attributes to the provided task entry that is added to the task backend.
protected void	cleanup() Cleanup task environment after offline run.
Class<?>	getTaskClass() Gets the Class that implements the utility to execute.
String	getTaskId() Gets an arbitrary task id assigned to this task.
String	getTaskObjectclass() Gets the objectclass used to represent scheduled instances of this utility in the task backend.
static void	main(String[] args) Processes the command-line arguments and invokes the rebuild process.
static int	mainRebuildIndex(String[] args, boolean canInitializeServer, OutputStream outStream, OutputStream errStream) Processes the command-line arguments and invokes the rebuild process.
protected com.forgerock.opendj.cli.ReturnCode	processLocal() Called when this utility should perform its actions locally in this JVM.
static void	rebuildIndexEmbeddedOffline(com.forgerock.opendj.cli.ArgumentsBuilder arguments, OutputStream outStream, OutputStream errStream) This method is used for running the rebuild-index tool programmatically against an offline server.
com.forgerock.opendj.cli.ReturnCode	rebuildIndexesWithinMultipleBackends(Collection<String> args) This function allow internal use of the rebuild index tools.
protected com.forgerock.opendj.cli.ReturnCode	runTaskTool(String[] args) Runs the concrete tool implementation with the provided arguments.

Methods inherited from class org.opends.server.tools.tasks.TaskTool

addAttribute, addAttributeIfArgumentPresent, getArgumentParser, getDependencyIds, getFailedDependencyAction, getNotifyUponCompletionEmailAddresses, getNotifyUponErrorEmailAddresses, getRecurringDateTime, getStartDateTime, isEmbedded, process, run, runEmbeddedOffline, runOffline, shutdownBackends, validateArguments, validateTaskArgs

Methods inherited from class com.forgerock.opendj.cli.Tool

askConfirmation, askPort, close, confirmAction, enableConsoleLoggingIfVerbose, errPrintln, errPrintln, errPrintln, errPrintlnSurroundedByBlankLines, errPrintVerboseMessage, flush, flushLogStream, getErrorStream, getErrStream, getInputStream, getOutputStream, isFullyInteractive, isQuiet, isScriptFriendly, isVerbose, logVerboseMessage, mayPrompt, parseArguments, pressReturnToContinue, print, println, println, println, println, printlnNoWrap, printlnSurroundedByBlankLines, printNoWrap, readInput, readInput, readInputAllowEmpty, readLineOfInput, readPassword, readPassword, readValidatedInput, readValidatedInput, report

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_LONG_REBUILD_ALL

public static final String OPTION_LONG_REBUILD_ALL

The value for the rebuild all long option.

See Also:

Constant Field Values

Constructor Detail

RebuildIndex

public RebuildIndex(OutputStream out,
                    OutputStream err,
                    boolean canInitializeServer)

Creates a new RebuildIndex with the provided output and error OutputStreams.

Parameters:

out - The tool output stream

err - The tool error stream

canInitializeServer - true if the server can be initialized, false otherwise (basically, because this is executed in the context of a unit-test).

Method Detail

main

public static void main(String[] args)

Processes the command-line arguments and invokes the rebuild process.

Parameters:

args - The command-line arguments provided to this program.

mainRebuildIndex

public static int mainRebuildIndex(String[] args,
                                   boolean canInitializeServer,
                                   OutputStream outStream,
                                   OutputStream errStream)

Processes the command-line arguments and invokes the rebuild process.

Parameters:

args - The command-line arguments provided to this program.

canInitializeServer - true if the server can be initialized, false otherwise (basically, because this is executed in the context of a unit-test).

outStream - The output stream to use for standard output, or null if standard output is not needed.

errStream - The output stream to use for standard error, or null if standard error is not needed.

Returns:

The error code.

rebuildIndexEmbeddedOffline

public static void rebuildIndexEmbeddedOffline(com.forgerock.opendj.cli.ArgumentsBuilder arguments,
                                               OutputStream outStream,
                                               OutputStream errStream)
                                        throws com.forgerock.opendj.cli.ClientException

This method is used for running the rebuild-index tool programmatically against an offline server.

The --offline and --noPropertyFile arguments are automatically added to the tool arguments.
Rebuilding indexes offline implies that the DirectoryServer will be initialized.

Parameters:

arguments - The command-line arguments provided to this program

outStream - The output stream to use for standard output, or null if standard output is not needed

errStream - The output stream to use for standard error, or null if standard error is not needed

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during the tool execution or if the tool has returned an error

runTaskTool

protected com.forgerock.opendj.cli.ReturnCode runTaskTool(String[] args)
                                                   throws com.forgerock.opendj.cli.ClientException

Description copied from class: TaskTool

Runs the concrete tool implementation with the provided arguments.

Specified by:

runTaskTool in class TaskTool

Parameters:

args - The command line arguments.

Returns:

The ReturnCode returned by the tool execution.

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs during tool execution.

processLocal

protected com.forgerock.opendj.cli.ReturnCode processLocal()
                                                    throws com.forgerock.opendj.cli.ClientException

Description copied from class: TaskTool

Called when this utility should perform its actions locally in this JVM.

Specified by:

processLocal in class TaskTool

Returns:

int indicating the result of this action

Throws:

com.forgerock.opendj.cli.ClientException - If an error occurs while running the tool

cleanup

protected void cleanup()

Description copied from class: TaskTool

Cleanup task environment after offline run. Default implementation does nothing. Tasks which initialize some static part of the DirectoryServer instance (e.g admin data local backends) must override this method to shutdown all needed component to prevent JVM environment alteration.

Overrides:

cleanup in class TaskTool

rebuildIndexesWithinMultipleBackends

public com.forgerock.opendj.cli.ReturnCode rebuildIndexesWithinMultipleBackends(Collection<String> args)

This function allow internal use of the rebuild index tools. This function rebuilds indexes shared by multiple backends.

Parameters:

args - The arguments used to launch the rebuild index process.

Returns:

The return code of this action.

getTaskId

public String getTaskId()

Description copied from interface: TaskScheduleInformation

Gets an arbitrary task id assigned to this task.

Returns:

assigned task id if any or null otherwise.

addTaskAttributes

public void addTaskAttributes(Entry taskEntry)

Description copied from interface: TaskScheduleInformation

Adds utility specific attributes to the provided task entry that is added to the task backend.

Parameters:

taskEntry - The task Entry to update.

getTaskObjectclass

public String getTaskObjectclass()

Description copied from interface: TaskScheduleInformation

Gets the objectclass used to represent scheduled instances of this utility in the task backend.

Returns:

String representation of this utilities objectclass

getTaskClass

public Class<?> getTaskClass()

Description copied from interface: TaskScheduleInformation

Gets the Class that implements the utility to execute.

Returns:

class of the tasks implementation