001    /*
002     * CDDL HEADER START
003     *
004     * The contents of this file are subject to the terms of the
005     * Common Development and Distribution License, Version 1.0 only
006     * (the "License").  You may not use this file except in compliance
007     * with the License.
008     *
009     * You can obtain a copy of the license at
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.server;
028    
029    
030    
031    import org.opends.server.admin.server.ConfigurationChangeListener;
032    import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
033    
034    
035    
036    /**
037     * A server-side interface for querying Task Backend settings.
038     * <p>
039     * The Task Backend provides a mechanism for scheduling tasks in the
040     * OpenDS Directory Server. Tasks are intended to provide access to
041     * certain types of administrative functions in the server that may not
042     * be convenient to perform remotely.
043     */
044    public interface TaskBackendCfg extends BackendCfg {
045    
046      /**
047       * Gets the configuration class associated with this Task Backend.
048       *
049       * @return Returns the configuration class associated with this Task Backend.
050       */
051      Class<? extends TaskBackendCfg> configurationClass();
052    
053    
054    
055      /**
056       * Register to be notified when this Task Backend is changed.
057       *
058       * @param listener
059       *          The Task Backend configuration change listener.
060       */
061      void addTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener);
062    
063    
064    
065      /**
066       * Deregister an existing Task Backend configuration change listener.
067       *
068       * @param listener
069       *          The Task Backend configuration change listener.
070       */
071      void removeTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener);
072    
073    
074    
075      /**
076       * Gets the "java-class" property.
077       * <p>
078       * Specifies the fully-qualified name of the Java class that
079       * provides the backend implementation.
080       *
081       * @return Returns the value of the "java-class" property.
082       */
083      String getJavaClass();
084    
085    
086    
087      /**
088       * Gets the "notification-sender-address" property.
089       * <p>
090       * Specifies the email address to use as the sender (that is, the
091       * "From:" address) address for notification mail messages generated
092       * when a task completes execution.
093       *
094       * @return Returns the value of the "notification-sender-address" property.
095       */
096      String getNotificationSenderAddress();
097    
098    
099    
100      /**
101       * Gets the "task-backing-file" property.
102       * <p>
103       * Specifies the path to the backing file for storing information
104       * about the tasks configured in the server.
105       * <p>
106       * It may be either an absolute path or a relative path to the base
107       * of the OpenDS Directory Server instance.
108       *
109       * @return Returns the value of the "task-backing-file" property.
110       */
111      String getTaskBackingFile();
112    
113    
114    
115      /**
116       * Gets the "task-retention-time" property.
117       * <p>
118       * Specifies the length of time that task entries should be retained
119       * after processing on the associated task has been completed.
120       *
121       * @return Returns the value of the "task-retention-time" property.
122       */
123      long getTaskRetentionTime();
124    
125    
126    
127      /**
128       * Gets the "writability-mode" property.
129       * <p>
130       * Specifies the behavior that the backend should use when
131       * processing write operations.
132       *
133       * @return Returns the value of the "writability-mode" property.
134       */
135      WritabilityMode getWritabilityMode();
136    
137    }