@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class ReloadGlobalIndexTask extends Task
NOTE: This class, and other classes within the
com.unboundid.ldap.sdk.unboundidds
package structure, are only
supported for use against Ping Identity, UnboundID, and Alcatel-Lucent 8661
server products. These classes provide support for proprietary
functionality or for external specifications that are not considered stable
or mature enough to be guaranteed to work in an interoperable way with
other types of LDAP servers.
Constructor and Description |
---|
ReloadGlobalIndexTask()
Creates a new uninitialized reload global index task instance which should
only be used for obtaining general information about this task, including
the task name, description, and supported properties.
|
ReloadGlobalIndexTask(Entry entry)
Creates a new reload global index task from the provided entry.
|
ReloadGlobalIndexTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new reload global index task from the provided set of task
properties.
|
ReloadGlobalIndexTask(java.lang.String taskID,
java.lang.String baseDN,
java.util.List<java.lang.String> indexNames,
java.lang.Boolean reloadFromDS,
java.lang.Boolean reloadInBackground,
java.lang.Long maxEntriesPerSecond)
Creates a new reload global index task with the provided information.
|
ReloadGlobalIndexTask(java.lang.String taskID,
java.lang.String baseDN,
java.util.List<java.lang.String> indexNames,
java.lang.Boolean reloadFromDS,
java.lang.Boolean reloadInBackground,
java.lang.Long maxEntriesPerSecond,
java.util.Date scheduledStartTime,
java.util.List<java.lang.String> dependencyIDs,
FailedDependencyAction failedDependencyAction,
java.util.List<java.lang.String> notifyOnCompletion,
java.util.List<java.lang.String> notifyOnError)
Creates a new reload global index task with the provided information.
|
Modifier and Type | Method and Description |
---|---|
protected java.util.List<Attribute> |
getAdditionalAttributes()
Retrieves a list of the additional attributes (other than attributes common
to all task types) that should be included when creating new task entries
of this type.
|
protected java.util.List<java.lang.String> |
getAdditionalObjectClasses()
Retrieves a list of the additional object classes (other than the base
"top" and "ds-task" classes) that should be included when creating new task
entries of this type.
|
java.lang.String |
getBaseDN()
Retrieves the base DN of the entry-balancing request processor for which to
reload index data.
|
java.util.List<java.lang.String> |
getIndexNames()
Retrieves the names of the indexes to be reloaded.
|
java.lang.Long |
getMaxEntriesPerSecond()
Retrieves the maximum reload rate in entries per second, if defined.
|
java.lang.String |
getTaskDescription()
Retrieves a human-readable description for this task.
|
java.lang.String |
getTaskName()
Retrieves a human-readable name for this task.
|
java.util.Map<TaskProperty,java.util.List<java.lang.Object>> |
getTaskPropertyValues()
Retrieves the values of the task properties for this task.
|
java.util.List<TaskProperty> |
getTaskSpecificProperties()
Retrieves a list of task-specific properties that may be provided when
scheduling a task of this type.
|
java.lang.Boolean |
reloadFromDS()
Indicates whether to reload index information from backend Directory
Servers rather than a peer Directory Proxy Server.
|
java.lang.Boolean |
reloadInBackground()
Indicates whether to perform the index reload processing in the background.
|
createTaskEntry, decodeTask, getActualStartTime, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString
public ReloadGlobalIndexTask()
public ReloadGlobalIndexTask(java.lang.String taskID, java.lang.String baseDN, java.util.List<java.lang.String> indexNames, java.lang.Boolean reloadFromDS, java.lang.Boolean reloadInBackground, java.lang.Long maxEntriesPerSecond)
taskID
- The task ID to use for this task. If it is
null
then a UUID will be generated for
use as the task ID.baseDN
- The base DN of the entry-balancing request
processor for which to reload index
information.indexNames
- The names of the attributes for which to
reload index data. This may be null
or empty to indicate that all indexes should
be reloaded.reloadFromDS
- Indicates whether to load index data from
backend Directory Server instances rather than
a peer Directory Proxy Server instance. This
may be null
to indicate that the
Directory Proxy Server should automatically
select the appropriate source for obtaining
index data.reloadInBackground
- Indicates whether to perform the reload in
the background, so that the task completes
immediately.maxEntriesPerSecond
- The maximum target rate at which to reload
index data (in entries per second). A value
of zero indicates no limit. A value of
null
indicates that the Directory
Proxy Server should attempt to determine the
limit based on its configuration.public ReloadGlobalIndexTask(java.lang.String taskID, java.lang.String baseDN, java.util.List<java.lang.String> indexNames, java.lang.Boolean reloadFromDS, java.lang.Boolean reloadInBackground, java.lang.Long maxEntriesPerSecond, java.util.Date scheduledStartTime, java.util.List<java.lang.String> dependencyIDs, FailedDependencyAction failedDependencyAction, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnError)
taskID
- The task ID to use for this task. If it is
null
then a UUID will be generated
for use as the task ID.baseDN
- The base DN of the entry-balancing request
processor for which to reload index
information.indexNames
- The names of the attributes for which to
reload index data. This may be
null
or empty to indicate that all
indexes should be reloaded.reloadFromDS
- Indicates whether to load index data from
backend Directory Server instances rather
than a peer Directory Proxy Server
instance. This may be null
to
indicate that the Directory Proxy Server
should automatically select the appropriate
source for obtaining index data.reloadInBackground
- Indicates whether to perform the reload in
the background, so that the task completes
immediately.maxEntriesPerSecond
- The maximum target rate at which to reload
index data (in entries per second). A
value of zero indicates no limit. A value
of null
indicates that the
Directory Proxy Server should attempt to
determine the limit based on its
configuration.scheduledStartTime
- The time that this task should start
running.dependencyIDs
- The list of task IDs that will be required
to complete before this task will be
eligible to start.failedDependencyAction
- Indicates what action should be taken if
any of the dependencies for this task do
not complete successfully.notifyOnCompletion
- The list of e-mail addresses of individuals
that should be notified when this task
completes.notifyOnError
- The list of e-mail addresses of individuals
that should be notified if this task does
not complete successfully.public ReloadGlobalIndexTask(Entry entry) throws TaskException
entry
- The entry to use to create this reload global index task.TaskException
- If the provided entry cannot be parsed as a reload
global index task entry.public ReloadGlobalIndexTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) throws TaskException
properties
- The set of task properties and their corresponding
values to use for the task. It must not be
null
.TaskException
- If the provided set of properties cannot be used to
create a valid reload global index task.public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
public java.lang.String getBaseDN()
public java.util.List<java.lang.String> getIndexNames()
public java.lang.Boolean reloadFromDS()
true
if the index information should be reloaded from
backend Directory Servers, false
if the index information
should be reloaded from a peer Directory Proxy Server instance, or
null
if the Directory Proxy Server should automatically
determine the reload data source.public java.lang.Boolean reloadInBackground()
true
if the index reload processing should be performed
in the background (so that the task completes immediately),
false
if not, or null
if the Directory Proxy
Server should determine whether to perform the reload in the
background.public java.lang.Long getMaxEntriesPerSecond()
null
if the
Directory Proxy Server should determine the maximum reload rate.protected java.util.List<java.lang.String> getAdditionalObjectClasses()
getAdditionalObjectClasses
in class Task
protected java.util.List<Attribute> getAdditionalAttributes()
getAdditionalAttributes
in class Task
public java.util.List<TaskProperty> getTaskSpecificProperties()
getTaskSpecificProperties
in class Task
public java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()
Boolean
,
Date
, Long
, or String
. Task properties which do
not have any values will be included in the map with an empty value list.
super.getTaskPropertyValues()
and the
values of their own task-specific properties.getTaskPropertyValues
in class Task