public class PurgeHistoricalUserData extends ReplicationUserData
Constructor and Description |
---|
PurgeHistoricalUserData()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
String |
getHostName()
Returns the host name of the server.
|
int |
getMaximumDuration()
Returns the maximum duration that the purge can take in seconds.
|
int |
getPort()
Returns the port of the server.
|
static BasicAttributes |
getTaskAttributes(PurgeHistoricalUserData uData)
Commodity method that returns the list of basic task attributes required
to launch a task corresponding to the provided user data.
|
static String |
getTaskDN(BasicAttributes attrs)
Returns the DN of the task corresponding to the provided list of
attributes.
|
static String |
getTaskID(BasicAttributes attrs)
Returns the ID of the task corresponding to the provided list of
attributes.
|
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 |
setHostName(String hostName)
Sets the host name 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 |
setPort(int port)
Sets the port of the server.
|
void |
setTaskSchedule(TaskScheduleUserData taskSchedule)
Sets the object describing the schedule of the task.
|
getAdminPwd, getAdminUid, getBaseDNs, setAdminPwd, setAdminUid, setBaseDNs
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 static BasicAttributes getTaskAttributes(PurgeHistoricalUserData uData)
uData
- the user data describing the purge historical to be executed.public static String getTaskDN(BasicAttributes attrs)
getTaskAttributes(PurgeHistoricalUserData)
.attrs
- the attributes of the task entry.public static String getTaskID(BasicAttributes attrs)
getTaskAttributes(PurgeHistoricalUserData)
.attrs
- the attributes of the task entry.public String getHostName()
public void setHostName(String hostName)
hostName
- the host name of the server.public int getPort()
public void setPort(int port)
port
- the port of the server.Copyright © 2010-2016 ForgeRock AS. All Rights Reserved.