|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.EnterLockdownModeTask
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class EnterLockdownModeTask
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class defines a Directory Server task that can be used to cause the server to enter lockdown mode, in which case it will only allow requests from users with the lockdown-mode privilege. Lockdown mode is intended to allow administrators to perform operations with the server online but without worrying about the impact that those operations may have on other users. In In some special cases, the server may place itself in lockdown mode as a defense mechanism rather than risking the exposure of sensitive information. For example, if the server detects any malformed access control rules at startup, then it will place itself in lockdown mode rather than attempt to run without that rule in effect since it could have been intended to prevent unauthorized users from accessing certain data.
LeaveLockdownModeTask
class for the corresponding mechanism to
bring the server out of lockdown mode.
Constructor Summary | |
---|---|
EnterLockdownModeTask()
Creates a new uninitialized enter lockdown mode task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties. |
|
EnterLockdownModeTask(Entry entry)
Creates a new enter lockdown mode task from the provided entry. |
|
EnterLockdownModeTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new enter lockdown mode task from the provided set of task properties. |
|
EnterLockdownModeTask(java.lang.String taskID)
Creates a new enter lockdown mode task with the specified task ID. |
|
EnterLockdownModeTask(java.lang.String taskID,
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 enter lockdown mode task with the provided information. |
|
EnterLockdownModeTask(java.lang.String taskID,
java.lang.String reason)
Creates a new enter lockdown mode task with the specified task ID. |
|
EnterLockdownModeTask(java.lang.String taskID,
java.lang.String reason,
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 enter lockdown mode task with the provided information. |
Method Summary | |
---|---|
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 |
getReason()
Retrieves the user-specified reason why the server is entering lockdown mode. |
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. |
Methods inherited from class com.unboundid.ldap.sdk.unboundidds.tasks.Task |
---|
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EnterLockdownModeTask()
public EnterLockdownModeTask(java.lang.String taskID)
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.public EnterLockdownModeTask(java.lang.String taskID, java.lang.String reason)
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.reason
- The user-specified reason for entering lockdown mode. This
may be null
.public EnterLockdownModeTask(java.lang.String taskID, 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.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 EnterLockdownModeTask(java.lang.String taskID, java.lang.String reason, 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.reason
- The user-specified reason for entering
lockdown mode. This may be null
.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 EnterLockdownModeTask(Entry entry) throws TaskException
entry
- The entry to use to create this enter lockdown mode task.
TaskException
- If the provided entry cannot be parsed as an enter
lockdown mode task entry.public EnterLockdownModeTask(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 enter lockdown mode task.Method Detail |
---|
public java.lang.String getReason()
null
if none was specified.public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |