org.opends.server.tools.dsreplication

Class PurgeHistoricalUserData

java.lang.Object

org.opends.server.tools.dsreplication.ReplicationUserData

org.opends.server.tools.dsreplication.PurgeHistoricalUserData

public class PurgeHistoricalUserData
extends ReplicationUserData

This class is used to store the information provided by the user to purge historical data.

Constructor Summary

Constructors

Constructor and Description
PurgeHistoricalUserData() Default constructor.

Method Summary

Modifier and Type	Method and Description
HostPort	getHostPort() Returns the host name and port of the server.
int	getMaximumDuration() Returns the maximum duration that the purge can take in seconds.
TaskScheduleUserData	getTaskSchedule() Returns the object describing the schedule of the task.
static void	initializeWithArgParser(PurgeHistoricalUserData uData, ReplicationCliArgumentParser argParser) Initializes the contents of the provided purge historical replication user data object with what was provided in the command-line without prompting to the user.
boolean	isOnline() Whether the task will be executed on an online server (using an LDAP connection and the tasks backend) or not.
void	setHostPort(HostPort hostPort) Sets the host name and port of the server.
void	setMaximumDuration(int maximumDuration) Sets the maximum duration that the purge can take in seconds.
void	setOnline(boolean online) Sets whether the task will be executed on an online server or not.
void	setTaskSchedule(TaskScheduleUserData taskSchedule) Sets the object describing the schedule of the task.

Methods inherited from class org.opends.server.tools.dsreplication.ReplicationUserData

addBaseDN, getAdminPwd, getAdminUid, getBaseDNs, setAdminPwd, setAdminUid, setBaseDNs, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PurgeHistoricalUserData

public PurgeHistoricalUserData()

Default constructor.

Method Detail

getMaximumDuration

public int getMaximumDuration()

Returns the maximum duration that the purge can take in seconds.

Returns:

the maximum duration that the purge can take in seconds.

setMaximumDuration

public void setMaximumDuration(int maximumDuration)

Sets the maximum duration that the purge can take in seconds.

Parameters:

maximumDuration - the maximum duration that the purge can take in seconds.

isOnline

public boolean isOnline()

Whether the task will be executed on an online server (using an LDAP connection and the tasks backend) or not.

Returns:

true if the task will be executed on an online server and false otherwise.

setOnline

public void setOnline(boolean online)

Sets whether the task will be executed on an online server or not.

Parameters:

online - true if the task will be executed on an online server and false otherwise.

getTaskSchedule

public TaskScheduleUserData getTaskSchedule()

Returns the object describing the schedule of the task. If the operation is not online, the value returned by this method should not be taken into account.

Returns:

the object describing the schedule of the task.

setTaskSchedule

public void setTaskSchedule(TaskScheduleUserData taskSchedule)

Sets the object describing the schedule of the task.

Parameters:

taskSchedule - the object describing the schedule of the task.

initializeWithArgParser

public static void initializeWithArgParser(PurgeHistoricalUserData uData,
                                           ReplicationCliArgumentParser argParser)

Initializes the contents of the provided purge historical replication user data object with what was provided in the command-line without prompting to the user.

Parameters:

uData - the purge historical replication user data object to be initialized.

argParser - the argument parser with the arguments provided by the user.

getHostPort

public HostPort getHostPort()

Returns the host name and port of the server.

Returns:

the host name and port of the server.

setHostPort

public void setHostPort(HostPort hostPort)

Sets the host name and port of the server.

Parameters:

hostPort - the host name and port of the server.