com.unboundid.ldap.sdk.unboundidds.tasks

Class ReloadGlobalIndexTask

java.lang.Object

com.unboundid.ldap.sdk.unboundidds.tasks.Task

com.unboundid.ldap.sdk.unboundidds.tasks.ReloadGlobalIndexTask

All Implemented Interfaces:

java.io.Serializable

@NotMutable
 @ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class ReloadGlobalIndexTask
extends Task

This class defines a Directory Proxy Server task that can be used to reload the contents of the global index.

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 Nokia/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.

The properties that are available for use with this type of task include:

• The base DN for the entry-balancing request processor.
• An optional set of attributes for which to reload the index information.
• A flag indicating whether to perform the reload in the background.
• A flag indicating whether to reload entries from backend Directory Server instances rather than a peer Directory Proxy Server instance.
• An optional maximum number of entries per second to access when priming.

See Also:

Serialized Form

Constructor Summary

Constructors

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.
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> notifyOnStart, java.util.List<java.lang.String> notifyOnCompletion, java.util.List<java.lang.String> notifyOnSuccess, java.util.List<java.lang.String> notifyOnError, java.lang.Boolean alertOnStart, java.lang.Boolean alertOnSuccess, java.lang.Boolean alertOnError) Creates a new reload global index task with the provided information.

Method Summary

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.

Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task

createTaskEntry, decodeTask, getActualStartTime, getAlertOnError, getAlertOnStart, getAlertOnSuccess, getAvailableTaskTypes, getCommonTaskProperties, getCompletionTime, getDependencyIDs, getFailedDependencyAction, getLogMessages, getNotifyOnCompletionAddresses, getNotifyOnErrorAddresses, getNotifyOnStartAddresses, getNotifyOnSuccessAddresses, getScheduledStartTime, getState, getTaskClassName, getTaskEntry, getTaskEntryDN, getTaskID, isCompleted, isPending, isRunning, parseBoolean, parseBooleanValue, parseDate, parseLong, parseString, parseStringList, parseStrings, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ReloadGlobalIndexTask

public 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. Attempts to use a task created with this constructor for any other reason will likely fail.

ReloadGlobalIndexTask

public ReloadGlobalIndexTask(@Nullable
                             java.lang.String taskID,
                             @NotNull
                             java.lang.String baseDN,
                             @Nullable
                             java.util.List<java.lang.String> indexNames,
                             @Nullable
                             java.lang.Boolean reloadFromDS,
                             @Nullable
                             java.lang.Boolean reloadInBackground,
                             @Nullable
                             java.lang.Long maxEntriesPerSecond)

Creates a new reload global index task with the provided information.

Parameters:

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.

ReloadGlobalIndexTask

public ReloadGlobalIndexTask(@Nullable
                             java.lang.String taskID,
                             @NotNull
                             java.lang.String baseDN,
                             @Nullable
                             java.util.List<java.lang.String> indexNames,
                             @Nullable
                             java.lang.Boolean reloadFromDS,
                             @Nullable
                             java.lang.Boolean reloadInBackground,
                             @Nullable
                             java.lang.Long maxEntriesPerSecond,
                             @Nullable
                             java.util.Date scheduledStartTime,
                             @Nullable
                             java.util.List<java.lang.String> dependencyIDs,
                             @Nullable
                             FailedDependencyAction failedDependencyAction,
                             @Nullable
                             java.util.List<java.lang.String> notifyOnCompletion,
                             @Nullable
                             java.util.List<java.lang.String> notifyOnError)

Creates a new reload global index task with the provided information.

Parameters:

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.

ReloadGlobalIndexTask

public ReloadGlobalIndexTask(@Nullable
                             java.lang.String taskID,
                             @NotNull
                             java.lang.String baseDN,
                             @Nullable
                             java.util.List<java.lang.String> indexNames,
                             @Nullable
                             java.lang.Boolean reloadFromDS,
                             @Nullable
                             java.lang.Boolean reloadInBackground,
                             @Nullable
                             java.lang.Long maxEntriesPerSecond,
                             @Nullable
                             java.util.Date scheduledStartTime,
                             @Nullable
                             java.util.List<java.lang.String> dependencyIDs,
                             @Nullable
                             FailedDependencyAction failedDependencyAction,
                             @Nullable
                             java.util.List<java.lang.String> notifyOnStart,
                             @Nullable
                             java.util.List<java.lang.String> notifyOnCompletion,
                             @Nullable
                             java.util.List<java.lang.String> notifyOnSuccess,
                             @Nullable
                             java.util.List<java.lang.String> notifyOnError,
                             @Nullable
                             java.lang.Boolean alertOnStart,
                             @Nullable
                             java.lang.Boolean alertOnSuccess,
                             @Nullable
                             java.lang.Boolean alertOnError)

Creates a new reload global index task with the provided information.

Parameters:

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.

notifyOnStart - The list of e-mail addresses of individuals that should be notified when this task starts running.

notifyOnCompletion - The list of e-mail addresses of individuals that should be notified when this task completes.

notifyOnSuccess - The list of e-mail addresses of individuals that should be notified if this task completes successfully.

notifyOnError - The list of e-mail addresses of individuals that should be notified if this task does not complete successfully.

alertOnStart - Indicates whether the server should send an alert notification when this task starts.

alertOnSuccess - Indicates whether the server should send an alert notification if this task completes successfully.

alertOnError - Indicates whether the server should send an alert notification if this task fails to complete successfully.

ReloadGlobalIndexTask

public ReloadGlobalIndexTask(@NotNull
                             Entry entry)
                      throws TaskException

Creates a new reload global index task from the provided entry.

Parameters:

entry - The entry to use to create this reload global index task.

Throws:

TaskException - If the provided entry cannot be parsed as a reload global index task entry.

ReloadGlobalIndexTask

public ReloadGlobalIndexTask(@NotNull
                             java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
                      throws TaskException

Creates a new reload global index task from the provided set of task properties.

Parameters:

properties - The set of task properties and their corresponding values to use for the task. It must not be null.

Throws:

TaskException - If the provided set of properties cannot be used to create a valid reload global index task.

Method Detail

getTaskName

@NotNull
public java.lang.String getTaskName()

Retrieves a human-readable name for this task.

Overrides:

getTaskName in class Task

Returns:

A human-readable name for this task.

getTaskDescription

@NotNull
public java.lang.String getTaskDescription()

Retrieves a human-readable description for this task.

Overrides:

getTaskDescription in class Task

Returns:

A human-readable description for this task.

getBaseDN

@NotNull
public java.lang.String getBaseDN()

Retrieves the base DN of the entry-balancing request processor for which to reload index data.

Returns:

The base DN of the entry-balancing request processor for which to reload index data.

getIndexNames

@NotNull
public java.util.List<java.lang.String> getIndexNames()

Retrieves the names of the indexes to be reloaded.

Returns:

The names of the indexes to be reloaded, or an empty list if the Directory Proxy Server should reload all indexes.

reloadFromDS

@Nullable
public java.lang.Boolean reloadFromDS()

Indicates whether to reload index information from backend Directory Servers rather than a peer Directory Proxy Server.

Returns:

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.

reloadInBackground

@Nullable
public java.lang.Boolean reloadInBackground()

Indicates whether to perform the index reload processing in the background.

Returns:

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.

getMaxEntriesPerSecond

@Nullable
public java.lang.Long getMaxEntriesPerSecond()

Retrieves the maximum reload rate in entries per second, if defined.

Returns:

The maximum rate at which to reload index data, in entries per second, zero if no limit should be imposed, or null if the Directory Proxy Server should determine the maximum reload rate.

getAdditionalObjectClasses

@NotNull
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.

Overrides:

getAdditionalObjectClasses in class Task

Returns:

A list of the additional object classes that should be included in new task entries of this type, or an empty list if there do not need to be any additional classes.

getAdditionalAttributes

@NotNull
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.

Overrides:

getAdditionalAttributes in class Task

Returns:

A list of the additional attributes that should be included in new task entries of this type, or an empty list if there do not need to be any additional attributes.

getTaskSpecificProperties

@NotNull
public java.util.List<TaskProperty> getTaskSpecificProperties()

Retrieves a list of task-specific properties that may be provided when scheduling a task of this type. This method should be overridden by subclasses in order to provide an appropriate set of properties.

Overrides:

getTaskSpecificProperties in class Task

Returns:

A list of task-specific properties that may be provided when scheduling a task of this type.

getTaskPropertyValues

@NotNull
public java.util.Map<TaskProperty,java.util.List<java.lang.Object>> getTaskPropertyValues()

Retrieves the values of the task properties for this task. The data type of the values will vary based on the data type of the corresponding task property and may be one of the following types: Boolean, Date, Long, or String. Task properties which do not have any values will be included in the map with an empty value list.

Note that subclasses which have additional task properties should override this method and return a map which contains both the property values from this class (obtained from super.getTaskPropertyValues() and the values of their own task-specific properties.

Overrides:

getTaskPropertyValues in class Task

Returns:

A map of the task property values for this task.