Package com.unboundid.ldap.sdk.unboundidds.tasks

Class RemoveAttributeTypeTask

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.Task
com.unboundid.ldap.sdk.unboundidds.tasks.RemoveAttributeTypeTask
All Implemented Interfaces:
Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RemoveAttributeTypeTask extends Task
This class defines a Directory Server task that can be used to safely remove an attribute type from the server schema. It will make sure that the attribute type is not in use in the server before removing it.
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.

The properties that are available for use with this type of task include:
  • The name or OID of the attribute type to remove from the server schema.
See Also:

  • Field Details

  • Constructor Details

    • RemoveAttributeTypeTask

      public RemoveAttributeTypeTask(@NotNull String attributeType)
      Creates a new remove attribute type task instance that will remove the specified attribute type from the server schema and will use the default values for all other properties.
      Parameters:
      attributeType - The name or OID of the attribute type to remove from the server schema.

    • RemoveAttributeTypeTask

      public RemoveAttributeTypeTask(@NotNull RemoveAttributeTypeTaskProperties properties)
      Creates a new remove attribute type task instance using the provided properties.
      Parameters:
      properties - The properties to use to create the remove attribute type task. It must not be null.

    • RemoveAttributeTypeTask

      public RemoveAttributeTypeTask(@NotNull Entry entry) throws TaskException
      Creates a new remove attribute type task from the provided entry.
      Parameters:
      entry - The entry to use to create this remove attribute type task.
      Throws:
      TaskException - If the provided entry cannot be parsed as a remove attribute tyep task entry.

    • RemoveAttributeTypeTask

      public RemoveAttributeTypeTask(@NotNull Map<TaskProperty,List<Object>> properties) throws TaskException
      Creates a new remove attribute type 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 remove attribute type task.

  • Method Details

    • getTaskName

      @NotNull public String getTaskName()
      Retrieves a human-readable name for this task.
      Overrides:
      getTaskName in class Task
      Returns:
      A human-readable name for this task.

    • getTaskDescription

      @NotNull public String getTaskDescription()
      Retrieves a human-readable description for this task.
      Overrides:
      getTaskDescription in class Task
      Returns:
      A human-readable description for this task.

    • getAttributeType

      @NotNull public String getAttributeType()
      Retrieves the name or OID of the attribute type to remove from the server schema.
      Returns:
      The name or OID of the attribute type to remove from the server schema.

    • getAdditionalObjectClasses

      @NotNull protected List<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

      @NotNull protected 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

      @NotNull public 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

      @NotNull public Map<TaskProperty,List<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.