|
|||||||||
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.DisconnectClientTask
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class DisconnectClientTask
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 request that the server terminate a client connection. The properties that are available for use with this type of task include:
Constructor Summary | |
---|---|
DisconnectClientTask()
Creates a new uninitialized disconnect client task instance which should only be used for obtaining general information about this task, including the task name, description, and supported properties. |
|
DisconnectClientTask(Entry entry)
Creates a new disconnect client task from the provided entry. |
|
DisconnectClientTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new disconnect client task from the provided set of task properties. |
|
DisconnectClientTask(java.lang.String taskID,
long connectionID,
java.lang.String disconnectMessage,
boolean notifyClient)
Creates a new disconnect client task with the provided information. |
|
DisconnectClientTask(java.lang.String taskID,
long connectionID,
java.lang.String disconnectMessage,
boolean notifyClient,
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 add disconnect client 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. |
long |
getConnectionID()
Retrieves the connection ID of the client connection to disconnect. |
java.lang.String |
getDisconnectMessage()
Retrieves the disconnect message to provide to the server, and potentially to the client. |
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. |
boolean |
notifyClient()
Indicates whether to send a notice of disconnection message to the client before terminating the connection. |
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 DisconnectClientTask()
public DisconnectClientTask(java.lang.String taskID, long connectionID, java.lang.String disconnectMessage, boolean notifyClient)
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.connectionID
- The connection ID of the client connection to
terminate.disconnectMessage
- A message to provide to the server to indicate
the reason for the disconnect. It will be
included in the server log, and will be provided
to the client if a notice of disconnection is to
be sent. It may be null
if no message
is to be provided.notifyClient
- Indicates whether to send a notice of
disconnection message to the client before
terminating the connection.public DisconnectClientTask(java.lang.String taskID, long connectionID, java.lang.String disconnectMessage, boolean notifyClient, 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.connectionID
- The connection ID of the client connection
to terminate.disconnectMessage
- A message to provide to the server to
indicate the reason for the disconnect. It
will be included in the server log, and
will be provided to the client if a notice
of disconnection is to be sent. It may be
null
if no message is to be
provided.notifyClient
- Indicates whether to send a notice of
disconnection message to the client before
terminating the connection.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 DisconnectClientTask(Entry entry) throws TaskException
entry
- The entry to use to create this disconnect client task.
TaskException
- If the provided entry cannot be parsed as a
disconnect client task entry.public DisconnectClientTask(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 disconnect client task.Method Detail |
---|
public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
public long getConnectionID()
public java.lang.String getDisconnectMessage()
null
if no message is to be
provided.public boolean notifyClient()
true
if the server should send a notice of disconnection
to the client, or false
if it should terminate the
connection without warning.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 |