Class RemoveObjectClassTask
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.tasks.Task
-
- com.unboundid.ldap.sdk.unboundidds.tasks.RemoveObjectClassTask
-
- All Implemented Interfaces:
java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class RemoveObjectClassTask extends Task
This class defines a Directory Server task that can be used to safely remove an object class from the server schema. It will make sure that the object class 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 object class to remove from the server schema.
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ATTR_OBJECT_CLASS
The name of the attribute used to specify the name or OID of the object class to remove from the server schema.static java.lang.String
OC_REMOVE_OBJECT_CLASS_TASK
The name of the object class used in remove object class task entries.
-
Constructor Summary
Constructors Constructor Description RemoveObjectClassTask(Entry entry)
Creates a new remove object class task from the provided entry.RemoveObjectClassTask(RemoveObjectClassTaskProperties properties)
Creates a new remove object class task instance using the provided properties.RemoveObjectClassTask(java.lang.String objectClass)
Creates a new remove object class task instance that will remove the specified object class from the server schema and will use the default values for all other properties.RemoveObjectClassTask(java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties)
Creates a new remove object class task from the provided set of task properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
getObjectClass()
Retrieves the name or OID of the object class to remove from the server schema.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, 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
-
-
-
-
Field Detail
-
ATTR_OBJECT_CLASS
@NotNull public static final java.lang.String ATTR_OBJECT_CLASS
The name of the attribute used to specify the name or OID of the object class to remove from the server schema.- See Also:
- Constant Field Values
-
OC_REMOVE_OBJECT_CLASS_TASK
@NotNull public static final java.lang.String OC_REMOVE_OBJECT_CLASS_TASK
The name of the object class used in remove object class task entries.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
RemoveObjectClassTask
public RemoveObjectClassTask(@NotNull java.lang.String objectClass)
Creates a new remove object class task instance that will remove the specified object class from the server schema and will use the default values for all other properties.- Parameters:
objectClass
- The name or OID of the object class to remove from the server schema.
-
RemoveObjectClassTask
public RemoveObjectClassTask(@NotNull RemoveObjectClassTaskProperties properties)
Creates a new remove object class task instance using the provided properties.- Parameters:
properties
- The properties to use to create the remove object class task. It must not benull
.
-
RemoveObjectClassTask
public RemoveObjectClassTask(@NotNull Entry entry) throws TaskException
Creates a new remove object class task from the provided entry.- Parameters:
entry
- The entry to use to create this remove object class task.- Throws:
TaskException
- If the provided entry cannot be parsed as a remove object class task entry.
-
RemoveObjectClassTask
public RemoveObjectClassTask(@NotNull java.util.Map<TaskProperty,java.util.List<java.lang.Object>> properties) throws TaskException
Creates a new remove object class 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 benull
.- Throws:
TaskException
- If the provided set of properties cannot be used to create a valid remove object class task.
-
-
Method Detail
-
getTaskName
@NotNull public java.lang.String getTaskName()
Retrieves a human-readable name for this task.- Overrides:
getTaskName
in classTask
- Returns:
- A human-readable name for this task.
-
getTaskDescription
@NotNull public java.lang.String getTaskDescription()
Retrieves a human-readable description for this task.- Overrides:
getTaskDescription
in classTask
- Returns:
- A human-readable description for this task.
-
getObjectClass
@NotNull public java.lang.String getObjectClass()
Retrieves the name or OID of the object class to remove from the server schema.- Returns:
- The name or OID of the object class to remove from the server schema.
-
getAdditionalObjectClasses
@NotNull 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 classTask
- 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 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 classTask
- 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 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 classTask
- Returns:
- A list of task-specific properties that may be provided when scheduling a task of this type.
-
getTaskPropertyValues
@NotNull 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
, orString
. 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 fromsuper.getTaskPropertyValues()
and the values of their own task-specific properties.- Overrides:
getTaskPropertyValues
in classTask
- Returns:
- A map of the task property values for this task.
-
-