@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CollectSupportDataTask 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
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.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_COMMENT
The name of the attribute used to specify a comment to include in the
support data archive.
|
static java.lang.String |
ATTR_ENCRYPTION_PASSPHRASE_FILE
The name of the attribute used to specify the path to a file containing the
passphrase to use to encrypt the contents of the support data archive.
|
static java.lang.String |
ATTR_INCLUDE_BINARY_FILES
The name of the attribute used to indicate whether the support data archive
may include binary files that may otherwise have been omitted.
|
static java.lang.String |
ATTR_INCLUDE_EXPENSIVE_DATA
The name of the attribute used to indicate whether the support data archive
should include information that may be expensive to capture.
|
static java.lang.String |
ATTR_INCLUDE_EXTENSION_SOURCE
The name of the attribute used to indicate whether the support data archive
may include the source code (if available) for any third-party extensions
installed in the server.
|
static java.lang.String |
ATTR_INCLUDE_REPLICATION_STATE_DUMP
The name of the attribute used to indicate whether the support data archive
should include a replication state dump (which may be several megabytes in
size).
|
static java.lang.String |
ATTR_JSTACK_COUNT
The name of the attribute used to specify the number of times to invoke the
jstack utility to capture server thread stack traces.
|
static java.lang.String |
ATTR_LOG_DURATION
The name of the attribute used to specify the length of time that should be
covered by the log data included in the support data archive.
|
static java.lang.String |
ATTR_OUTPUT_PATH
The name of the attribute used to specify the path to which the support
data archive should be written.
|
static java.lang.String |
ATTR_REPORT_COUNT
The name of the attribute used to specify the number of intervals to
capture for tools that capture multiple samples.
|
static java.lang.String |
ATTR_REPORT_INTERVAL_SECONDS
The name of the attribute used to specify the length of time, in seconds,
between samples collected from tools that capture multiple samples.
|
static java.lang.String |
ATTR_RETAIN_PREVIOUS_ARCHIVE_AGE
The name of the attribute used to specify the minimum age of previous
support data archives that should be retained.
|
static java.lang.String |
ATTR_RETAIN_PREVIOUS_ARCHIVE_COUNT
The name of the attribute used to specify the minimum number of previous
support data archives that should be retained.
|
static java.lang.String |
ATTR_SECURITY_LEVEL
The name of the attribute used to specify the security level to use for
information added to the support data archive.
|
static java.lang.String |
ATTR_USE_SEQUENTIAL_MODE
The name of the attribute used to indicate whether to collect items
sequentially rather than in parallel.
|
static java.lang.String |
OC_COLLECT_SUPPORT_DATA_TASK
The name of the object class used in collect support data task entries.
|
Constructor and Description |
---|
CollectSupportDataTask()
Creates a new collect support data task instance that will use default
settings for all properties.
|
CollectSupportDataTask(CollectSupportDataTaskProperties properties)
Creates a new collect support data task instance using the provided
properties.
|
CollectSupportDataTask(Entry entry)
Creates a new collect support data task from the provided entry.
|
CollectSupportDataTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new collect support data task from the provided set of task
properties.
|
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 |
getComment()
Retrieves an additional comment that should be included in the support data
archive.
|
java.lang.String |
getEncryptionPassphraseFile()
Retrieves the path on the server filesystem to a file that contains the
passphrase to use to encrypt the support data archive.
|
java.lang.Boolean |
getIncludeBinaryFiles()
Retrieves the value of a flag that indicates whether the support data
archive may include binary files.
|
java.lang.Boolean |
getIncludeExpensiveData()
Retrieves the value of a flag that indicates whether the support data
archive may include data that is potentially expensive to collect and
could affect the performance or responsiveness of the server.
|
java.lang.Boolean |
getIncludeExtensionSource()
Retrieves the value of a flag that indicates whether the support data
archive should include source code (if available) for any third-party
extensions installed in the server.
|
java.lang.Boolean |
getIncludeReplicationStateDump()
Retrieves the value of a flag that indicates whether the support data
archive may include a replication state dump, which may be several
megabytes in size.
|
java.lang.Integer |
getJStackCount()
Retrieves the number of times that the jstack utility should be invoked to
obtain stack traces from all threads in the server.
|
java.lang.String |
getLogDuration()
Retrieves a string representation of the duration (up until the time that
the collect support data task is invoked) of log content that should be
included in the support data archive.
|
java.lang.Long |
getLogDurationMillis()
Retrieves a parsed value of the log duration in milliseconds.
|
java.lang.String |
getOutputPath()
Retrieves the path on the server filesystem to which the support data
archive should be written.
|
java.lang.Integer |
getReportCount()
Retrieves the number of intervals that should be captured from tools that
use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).
|
java.lang.Integer |
getReportIntervalSeconds()
Retrieves the interval duration in seconds that should be used for tools
that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).
|
java.lang.String |
getRetainPreviousSupportDataArchiveAge()
Retrieves the minimum age of existing support data archives that should be
retained.
|
java.lang.Long |
getRetainPreviousSupportDataArchiveAgeMillis()
Retrieves a parsed value of the retain previous support data archive age in
milliseconds.
|
java.lang.Integer |
getRetainPreviousSupportDataArchiveCount()
Retrieves the minimum number of existing support data archives that should
be retained.
|
CollectSupportDataSecurityLevel |
getSecurityLevel()
Retrieves the security level that should be used to indicate which data
should be obscured, redacted, or omitted from the support data archive.
|
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 |
getUseSequentialMode()
Retrieves the value of a flag that indicates whether the server should
collect items for the support data archive in sequential mode rather than
in parallel.
|
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
public static final java.lang.String ATTR_COMMENT
public static final java.lang.String ATTR_ENCRYPTION_PASSPHRASE_FILE
public static final java.lang.String ATTR_INCLUDE_BINARY_FILES
public static final java.lang.String ATTR_INCLUDE_EXPENSIVE_DATA
public static final java.lang.String ATTR_INCLUDE_EXTENSION_SOURCE
public static final java.lang.String ATTR_INCLUDE_REPLICATION_STATE_DUMP
public static final java.lang.String ATTR_JSTACK_COUNT
public static final java.lang.String ATTR_LOG_DURATION
public static final java.lang.String ATTR_OUTPUT_PATH
public static final java.lang.String ATTR_REPORT_COUNT
public static final java.lang.String ATTR_REPORT_INTERVAL_SECONDS
public static final java.lang.String ATTR_RETAIN_PREVIOUS_ARCHIVE_AGE
public static final java.lang.String ATTR_RETAIN_PREVIOUS_ARCHIVE_COUNT
public static final java.lang.String ATTR_SECURITY_LEVEL
public static final java.lang.String ATTR_USE_SEQUENTIAL_MODE
public static final java.lang.String OC_COLLECT_SUPPORT_DATA_TASK
public CollectSupportDataTask()
public CollectSupportDataTask(CollectSupportDataTaskProperties properties)
properties
- The properties to use to create the collect support
data task. It must not be null
.public CollectSupportDataTask(Entry entry) throws TaskException
entry
- The entry to use to create this collect support data task.TaskException
- If the provided entry cannot be parsed as a collect
support data task entry.public CollectSupportDataTask(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 collect support data task.public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
public java.lang.String getOutputPath()
null
if no value has been
specified for the property.public java.lang.String getEncryptionPassphraseFile()
null
if no value has been specified for the property, and
the support data archive should not be encrypted.public java.lang.Boolean getIncludeExpensiveData()
null
if the property should not be specified when the
task is created (in which case the server will use a default
behavior of excluding expensive data).public java.lang.Boolean getIncludeReplicationStateDump()
null
if
the property should not be specified when the task is created (in
which case the server will use a default behavior of excluding the
state dump).public java.lang.Boolean getIncludeBinaryFiles()
null
if the property
should not be specified when the task is created (in which case
the server will use a default behavior of excluding binary files).public java.lang.Boolean getIncludeExtensionSource()
null
if
the property should not be specified when the task is created (in
which case the server will use a default behavior of excluding
extension source code).public java.lang.Boolean getUseSequentialMode()
null
if the property should
not be specified when the task is created (in which case the
server will default to capturing data in parallel).public CollectSupportDataSecurityLevel getSecurityLevel()
null
if the property should not be
specified when the task is created (in which case the server will
use a default security level).public java.lang.Integer getReportCount()
null
if the property
should not be specified when the task is created (in which case
the server will use a default report count).public java.lang.Integer getReportIntervalSeconds()
null
if the property
should not be specified when the task is created (in which case
the server will use a default report interval).public java.lang.Integer getJStackCount()
null
if the property should not be specified when the task
is created (in which case the server will use a default count).public java.lang.String getLogDuration()
null
if the
property should not be specified when the task is created (in
which case the server will use a default behavior for selecting
the amount of log content to include).public java.lang.Long getLogDurationMillis() throws TaskException
null
if no log duration is set.TaskException
- If the log duration value cannot be parsed as a
valid duration.public java.lang.String getComment()
null
if no comment should be included.public java.lang.Integer getRetainPreviousSupportDataArchiveCount()
null
if there is no minimum retain count.public java.lang.String getRetainPreviousSupportDataArchiveAge()
null
if there is no minimum retain age.public java.lang.Long getRetainPreviousSupportDataArchiveAgeMillis() throws TaskException
null
if no retain age is set.TaskException
- If the retain age value cannot be parsed as a valid
duration.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