com.unboundid.ldap.sdk.unboundidds.tasks
Class AuditDataSecurityTask

java.lang.Object
  extended by com.unboundid.ldap.sdk.unboundidds.tasks.Task
      extended by com.unboundid.ldap.sdk.unboundidds.tasks.AuditDataSecurityTask
All Implemented Interfaces:
java.io.Serializable

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

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 initiate a data security audit, which can look for potential issues in the environment that can impact the security of the directory environment.

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

See Also:
Serialized Form

Constructor Summary
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.
 
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.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.
 
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

AuditDataSecurityTask

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


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)
Creates a new audit data security task with the provided information and default settings for all general task properties.

Parameters:
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.

AuditDataSecurityTask

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)
Creates a new audit data security 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.
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.

AuditDataSecurityTask

public AuditDataSecurityTask(Entry entry)
                      throws TaskException
Creates a new audit data security task from the provided entry.

Parameters:
entry - The entry to use to create this audit data security task.
Throws:
TaskException - If the provided entry cannot be parsed as an audit data security task entry.

AuditDataSecurityTask

public AuditDataSecurityTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
                      throws TaskException
Creates a new audit data security 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 audit data security task.
Method Detail

getTaskName

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

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.

getIncludeAuditors

public java.util.List<java.lang.String> getIncludeAuditors()
Retrieves the names of the auditors that should be invoked during the data security audit.

Returns:
The names of the include auditors that should be used for the task, or an empty list if either an exclude list should be used or all enabled auditors should be used.

getExcludeAuditors

public java.util.List<java.lang.String> getExcludeAuditors()
Retrieves the names of the auditors that should not be invoked during the audit.

Returns:
The names of the exclude auditors that should be used for the task, or an empty list if either an include list should be used or all enabled auditors should be used.

getBackendIDs

public java.util.List<java.lang.String> getBackendIDs()
Retrieves the backend IDs of the backends that should be examined during the course of the audit.

Returns:
The backend IDs of the backends that should be examined during the course of the audit, or an empty list if all backends that support this capability should be used.

getReportFilterStrings

public 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.

Returns:
The string representations of the report filters that should be used to identify which entries should be examined during the course of the audit, or an empty list if all entries should be examined.

getReportFilters

public java.util.List<Filter> getReportFilters()
                                        throws LDAPException
Retrieves the parsed report filters that should be used to identify which entries should be examined during the course of the audit.

Returns:
The parsed report filters that should be used to identify which entries should be examined during the course of the audit, or an empty list if all entries should be examined.
Throws:
LDAPException - If any of the filter strings cannot be parsed as a valid filter.

getOutputDirectory

public java.lang.String getOutputDirectory()
Retrieves the path to the directory on the server filesystem in which the report output files should be written.

Returns:
The path to the directory on the server filesystem in which the report output files should be written.

getAdditionalObjectClasses

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

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

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

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.