Package org.opends.server.tools.dsreplication

Class LocalPurgeHistorical

java.lang.Object

org.opends.server.tools.dsreplication.LocalPurgeHistorical

public class LocalPurgeHistorical
extends Object

The class that is in charge of taking the different information provided by the user through the command-line and actually executing the local purge.

Constructor Summary

Constructors

Constructor	Description
LocalPurgeHistorical(PurgeHistoricalUserData uData, ConsoleApplication app, ProgressMessageFormatter formatter, String configFile)	The default constructor.

Method Summary

Modifier and Type	Method	Description
ReplicationCliReturnCode	execute()	Executes the purge historical operation locally.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalPurgeHistorical

public LocalPurgeHistorical(PurgeHistoricalUserData uData,
                            ConsoleApplication app,
                            ProgressMessageFormatter formatter,
                            String configFile)

The default constructor.

Parameters:

uData - the object containing the information provided by the user.

app - the console application that is used to write the progress and error messages.

formatter - the formatter to be used to generated the messages.

configFile - the file that contains the configuration. This is required to initialize properly the server.

Method Detail

execute

public ReplicationCliReturnCode execute()

Executes the purge historical operation locally.

Returns:

the result code.