<?xml version="1.0" encoding="UTF-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
! or http://forgerock.org/license/CDDLv1.0.html.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at legal-notices/CDDLv1_0.txt.
|
! If applicable, add the following below this CDDL HEADER, with the
|
! fields enclosed by brackets "[]" replaced with your own identifying
|
! information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2007-2008 Sun Microsystems, Inc.
|
! Portions Copyright 2011 ForgeRock AS
|
! -->
|
<adm:managed-object name="task-backend" plural-name="task-backends"
|
package="org.forgerock.opendj.admin" extends="backend"
|
advanced="true" xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap">
|
<adm:synopsis>
|
The Task Backend provides a mechanism for scheduling tasks in the
|
<adm:product-name /> 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.
|
</adm:synopsis>
|
<adm:description>
|
<adm:product-name /> supports tasks to backup and restore backends, to import and export LDIF
|
files, and to stop and restart the server. The details of a task are
|
in an entry that is below the root of the Task Backend. The Task Backend
|
is responsible for decoding that task entry and ensuring that it is processed
|
as requested. Tasks may be invoked immediately, but they may also be scheduled for execution at
|
some future time. The task backend can also process recurring tasks to
|
ensure that maintenance operations (for example, backups) are
|
performed automatically on a regular basis.
|
</adm:description>
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-task-backend</ldap:name>
|
<ldap:superior>ds-cfg-backend</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:property-override name="java-class" advanced="true">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>
|
org.opends.server.backends.task.TaskBackend
|
</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property-override name="writability-mode">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>enabled</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property name="task-backing-file" mandatory="true">
|
<adm:synopsis>
|
Specifies the path to the backing file for storing
|
information about the tasks configured in the server.
|
</adm:synopsis>
|
<adm:description>
|
It may be either an absolute path or a relative path to
|
the base of the <adm:product-name /> directory server instance.
|
</adm:description>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-task-backing-file</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="task-retention-time">
|
<adm:synopsis>
|
Specifies the length of time that task entries should be
|
retained after processing on the associated task has been
|
completed.
|
</adm:synopsis>
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>24 hours</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:duration />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-task-retention-time</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="notification-sender-address">
|
<adm:synopsis>
|
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.
|
</adm:synopsis>
|
<adm:default-behavior>
|
<adm:alias>
|
<adm:synopsis>
|
The default sender address used is
|
"opendj-task-notification@" followed by the canonical address
|
of the system on which the server is running.
|
</adm:synopsis>
|
</adm:alias>
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string />
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-notification-sender-address</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
</adm:managed-object>
|
