|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.AbstractManagedObjectDefinition<C,S>
org.opends.server.admin.ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>
org.opends.server.admin.std.meta.TaskBackendCfgDefn
public final class TaskBackendCfgDefn
An interface for querying the Task Backend managed object definition meta information.
The Task Backend provides a mechanism for scheduling tasks in the OpenDS Directory Server. Tasks are intended to provide access to certain types of administrative functions in the server that may not be convenient to perform remotely.
Method Summary | |
---|---|
TaskBackendCfgClient |
createClientConfiguration(ManagedObject<? extends TaskBackendCfgClient> impl)
Creates a client configuration view of the provided managed object. |
TaskBackendCfg |
createServerConfiguration(ServerManagedObject<? extends TaskBackendCfg> impl)
Creates a server configuration view of the provided server managed object. |
StringPropertyDefinition |
getBackendIdPropertyDefinition()
Get the "backend-id" property definition. |
DNPropertyDefinition |
getBaseDNPropertyDefinition()
Get the "base-dn" property definition. |
BooleanPropertyDefinition |
getEnabledPropertyDefinition()
Get the "enabled" property definition. |
static TaskBackendCfgDefn |
getInstance()
Get the Task Backend configuration definition singleton. |
ClassPropertyDefinition |
getJavaClassPropertyDefinition()
Get the "java-class" property definition. |
StringPropertyDefinition |
getNotificationSenderAddressPropertyDefinition()
Get the "notification-sender-address" property definition. |
java.lang.Class<TaskBackendCfg> |
getServerConfigurationClass()
Gets the server configuration class instance associated with this managed object definition. |
StringPropertyDefinition |
getTaskBackingFilePropertyDefinition()
Get the "task-backing-file" property definition. |
DurationPropertyDefinition |
getTaskRetentionTimePropertyDefinition()
Get the "task-retention-time" property definition. |
EnumPropertyDefinition<BackendCfgDefn.WritabilityMode> |
getWritabilityModePropertyDefinition()
Get the "writability-mode" property definition. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public static TaskBackendCfgDefn getInstance()
public TaskBackendCfgClient createClientConfiguration(ManagedObject<? extends TaskBackendCfgClient> impl)
createClientConfiguration
in class ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>
impl
- The managed object.
public TaskBackendCfg createServerConfiguration(ServerManagedObject<? extends TaskBackendCfg> impl)
createServerConfiguration
in class ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>
impl
- The server managed object.
public java.lang.Class<TaskBackendCfg> getServerConfigurationClass()
getServerConfigurationClass
in class ManagedObjectDefinition<TaskBackendCfgClient,TaskBackendCfg>
public StringPropertyDefinition getBackendIdPropertyDefinition()
Specifies a name to identify the associated backend.
The name must be unique among all backends in the server. The backend ID may not be altered after the backend is created in the server.
public DNPropertyDefinition getBaseDNPropertyDefinition()
Specifies the base DN(s) for the data that the backend handles.
A single backend may be responsible for one or more base DNs. Note that no two backends may have the same base DN although one backend may have a base DN that is below a base DN provided by another backend (similar to the use of sub-suffixes in the Sun Java System Directory Server). If any of the base DNs is subordinate to a base DN for another backend, then all base DNs for that backend must be subordinate to that same base DN.
public BooleanPropertyDefinition getEnabledPropertyDefinition()
Indicates whether the backend is enabled in the server.
If a backend is not enabled, then its contents are not accessible when processing operations.
public ClassPropertyDefinition getJavaClassPropertyDefinition()
Specifies the fully-qualified name of the Java class that provides the backend implementation.
public StringPropertyDefinition getNotificationSenderAddressPropertyDefinition()
Specifies the email address to use as the sender (that is, the "From:" address) address for notification mail messages generated when a task completes execution.
public StringPropertyDefinition getTaskBackingFilePropertyDefinition()
Specifies the path to the backing file for storing information about the tasks configured in the server.
It may be either an absolute path or a relative path to the base of the OpenDS Directory Server instance.
public DurationPropertyDefinition getTaskRetentionTimePropertyDefinition()
Specifies the length of time that task entries should be retained after processing on the associated task has been completed.
public EnumPropertyDefinition<BackendCfgDefn.WritabilityMode> getWritabilityModePropertyDefinition()
Specifies the behavior that the backend should use when processing write operations.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |