@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class AuditDataSecurityTask 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 |
---|
AuditDataSecurityTask()
Creates a new uninitialized audit data security task instance which should
only be used for obtaining general information about this task, including
the task name, description, and supported properties.
|
AuditDataSecurityTask(Entry entry)
Creates a new audit data security task from the provided entry.
|
AuditDataSecurityTask(java.util.List<java.lang.String> includeAuditors,
java.util.List<java.lang.String> excludeAuditors,
java.util.List<java.lang.String> backendIDs,
java.util.List<java.lang.String> reportFilters,
java.lang.String outputDirectory)
Creates a new audit data security task with the provided information and
default settings for all general task properties.
|
AuditDataSecurityTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new audit data security task from the provided set of task
properties.
|
AuditDataSecurityTask(java.lang.String taskID,
java.util.List<java.lang.String> includeAuditors,
java.util.List<java.lang.String> excludeAuditors,
java.util.List<java.lang.String> backendIDs,
java.util.List<java.lang.String> reportFilters,
java.lang.String outputDirectory,
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 audit data security 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.util.List<java.lang.String> |
getBackendIDs()
Retrieves the backend IDs of the backends that should be examined during
the course of the audit.
|
java.util.List<java.lang.String> |
getExcludeAuditors()
Retrieves the names of the auditors that should not be invoked during the
audit.
|
java.util.List<java.lang.String> |
getIncludeAuditors()
Retrieves the names of the auditors that should be invoked during the
data security audit.
|
java.lang.String |
getOutputDirectory()
Retrieves the path to the directory on the server filesystem in which the
report output files should be written.
|
java.util.List<Filter> |
getReportFilters()
Retrieves the parsed report filters that should be used to identify which
entries should be examined during the course of the audit.
|
java.util.List<java.lang.String> |
getReportFilterStrings()
Retrieves the string representations of the report filters that should be
used to identify which entries should be examined during the course of the
audit.
|
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.
|
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 AuditDataSecurityTask()
public AuditDataSecurityTask(java.util.List<java.lang.String> includeAuditors, java.util.List<java.lang.String> excludeAuditors, java.util.List<java.lang.String> backendIDs, java.util.List<java.lang.String> reportFilters, java.lang.String outputDirectory)
includeAuditors
- The names of the auditors that should be used to
examine the data. It may be null
or empty
if an exclude list should be provided, or if all
enabled auditors should be invoked. You must not
provide both include and exclude auditors.excludeAuditors
- The names of the auditors that should be excluded
when examining the data. It may be null
or empty if an include list should be provided, or
if all enabled auditors should be invoked. You
must not provide both include and exclude
auditors.backendIDs
- The backend IDs of the backends containing the
data to examine. It may be null
or empty
if all supported backends should be selected.reportFilters
- A set of filters which identify entries that
should be examined. It may be null
or
empty if all entries should be examined.outputDirectory
- The path to the output directory (on the server
filesystem) in which report data files should be
written. It may be null
if a default
output directory should be used.public AuditDataSecurityTask(java.lang.String taskID, java.util.List<java.lang.String> includeAuditors, java.util.List<java.lang.String> excludeAuditors, java.util.List<java.lang.String> backendIDs, java.util.List<java.lang.String> reportFilters, java.lang.String outputDirectory, 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.includeAuditors
- The names of the auditors that should be
used to examine the data. It may be
null
or empty if an exclude list
should be provided, or if all enabled
auditors should be invoked. You must not
provide both include and exclude auditors.excludeAuditors
- The names of the auditors that should be
excluded when examining the data. It may
be null
or empty if an include list
should be provided, or if all enabled
auditors should be invoked. You must not
provide both include and exclude auditors.backendIDs
- The backend IDs of the backends containing
the data to examine. It may be
null
or empty if all supported
backends should be selected.reportFilters
- A set of filters which identify entries
that should be examined. It may be
null
or empty if all entries should
be examined.outputDirectory
- The path to the output directory (on the
server filesystem) in which report data
files should be written. It may be
null
if a default output directory
should be used.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 AuditDataSecurityTask(Entry entry) throws TaskException
entry
- The entry to use to create this audit data security task.TaskException
- If the provided entry cannot be parsed as an audit
data security task entry.public AuditDataSecurityTask(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 audit data security task.public java.lang.String getTaskName()
getTaskName
in class Task
public java.lang.String getTaskDescription()
getTaskDescription
in class Task
public java.util.List<java.lang.String> getIncludeAuditors()
public java.util.List<java.lang.String> getExcludeAuditors()
public java.util.List<java.lang.String> getBackendIDs()
public java.util.List<java.lang.String> getReportFilterStrings()
public java.util.List<Filter> getReportFilters() throws LDAPException
LDAPException
- If any of the filter strings cannot be parsed as a
valid filter.public java.lang.String getOutputDirectory()
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