public class PurgeHistoricalUserData extends ReplicationUserData
Constructor and Description |
---|
PurgeHistoricalUserData()
Default constructor.
|
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.
|
addBaseDN, getAdminPwd, getAdminUid, getBaseDNs, setAdminPwd, setAdminUid, setBaseDNs, toString
public PurgeHistoricalUserData()
public int getMaximumDuration()
public void setMaximumDuration(int maximumDuration)
maximumDuration
- the maximum duration that the purge can take in
seconds.public boolean isOnline()
true
if the task will be executed on an online server
and false
otherwise.public void setOnline(boolean online)
online
- true
if the task will be executed on an online server
and false
otherwise.public TaskScheduleUserData getTaskSchedule()
public void setTaskSchedule(TaskScheduleUserData taskSchedule)
taskSchedule
- the object describing the schedule of the task.public static void initializeWithArgParser(PurgeHistoricalUserData uData, ReplicationCliArgumentParser argParser)
uData
- the purge historical replication user data object to be
initialized.argParser
- the argument parser with the arguments provided by the
user.public HostPort getHostPort()
public void setHostPort(HostPort hostPort)
hostPort
- the host name and port of the server.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.