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 legal-notices/CDDLv1_0.txt
010 * or http://forgerock.org/license/CDDLv1.0.html.
011 * See the License for the specific language governing permissions
012 * and limitations under the License.
013 *
014 * When distributing Covered Code, include this CDDL HEADER in each
015 * file and include the License file at legal-notices/CDDLv1_0.txt.
016 * If applicable, add the following below this CDDL HEADER, with the
017 * fields enclosed by brackets "[]" replaced with your own identifying
018 * information:
019 *      Portions Copyright [yyyy] [name of copyright owner]
020 *
021 * CDDL HEADER END
022 *
023 *
024 *      Copyright 2008 Sun Microsystems, Inc.
025 */
026package org.opends.server.admin.std.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
033import org.opends.server.admin.std.server.TaskBackendCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Task Backend
039 * settings.
040 * <p>
041 * The Task Backend provides a mechanism for scheduling tasks in the
042 * OpenDJ directory server. Tasks are intended to provide access to
043 * certain types of administrative functions in the server that may not
044 * be convenient to perform remotely.
045 */
046public interface TaskBackendCfgClient extends BackendCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Task Backend.
050   *
051   * @return Returns the configuration definition associated with this Task Backend.
052   */
053  ManagedObjectDefinition<? extends TaskBackendCfgClient, ? extends TaskBackendCfg> definition();
054
055
056
057  /**
058   * Gets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the Java class that
061   * provides the backend implementation.
062   *
063   * @return Returns the value of the "java-class" property.
064   */
065  String getJavaClass();
066
067
068
069  /**
070   * Sets the "java-class" property.
071   * <p>
072   * Specifies the fully-qualified name of the Java class that
073   * provides the backend implementation.
074   *
075   * @param value The value of the "java-class" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setJavaClass(String value) throws PropertyException;
080
081
082
083  /**
084   * Gets the "notification-sender-address" property.
085   * <p>
086   * Specifies the email address to use as the sender (that is, the
087   * "From:" address) address for notification mail messages generated
088   * when a task completes execution.
089   *
090   * @return Returns the value of the "notification-sender-address" property.
091   */
092  String getNotificationSenderAddress();
093
094
095
096  /**
097   * Sets the "notification-sender-address" property.
098   * <p>
099   * Specifies the email address to use as the sender (that is, the
100   * "From:" address) address for notification mail messages generated
101   * when a task completes execution.
102   *
103   * @param value The value of the "notification-sender-address" property.
104   * @throws PropertyException
105   *           If the new value is invalid.
106   */
107  void setNotificationSenderAddress(String value) throws PropertyException;
108
109
110
111  /**
112   * Gets the "task-backing-file" property.
113   * <p>
114   * Specifies the path to the backing file for storing information
115   * about the tasks configured in the server.
116   * <p>
117   * It may be either an absolute path or a relative path to the base
118   * of the OpenDJ directory server instance.
119   *
120   * @return Returns the value of the "task-backing-file" property.
121   */
122  String getTaskBackingFile();
123
124
125
126  /**
127   * Sets the "task-backing-file" property.
128   * <p>
129   * Specifies the path to the backing file for storing information
130   * about the tasks configured in the server.
131   * <p>
132   * It may be either an absolute path or a relative path to the base
133   * of the OpenDJ directory server instance.
134   *
135   * @param value The value of the "task-backing-file" property.
136   * @throws PropertyException
137   *           If the new value is invalid.
138   */
139  void setTaskBackingFile(String value) throws PropertyException;
140
141
142
143  /**
144   * Gets the "task-retention-time" property.
145   * <p>
146   * Specifies the length of time that task entries should be retained
147   * after processing on the associated task has been completed.
148   *
149   * @return Returns the value of the "task-retention-time" property.
150   */
151  long getTaskRetentionTime();
152
153
154
155  /**
156   * Sets the "task-retention-time" property.
157   * <p>
158   * Specifies the length of time that task entries should be retained
159   * after processing on the associated task has been completed.
160   *
161   * @param value The value of the "task-retention-time" property.
162   * @throws PropertyException
163   *           If the new value is invalid.
164   */
165  void setTaskRetentionTime(Long value) throws PropertyException;
166
167
168
169  /**
170   * Gets the "writability-mode" property.
171   * <p>
172   * Specifies the behavior that the backend should use when
173   * processing write operations.
174   *
175   * @return Returns the value of the "writability-mode" property.
176   */
177  WritabilityMode getWritabilityMode();
178
179
180
181  /**
182   * Sets the "writability-mode" property.
183   * <p>
184   * Specifies the behavior that the backend should use when
185   * processing write operations.
186   *
187   * @param value The value of the "writability-mode" property.
188   * @throws PropertyException
189   *           If the new value is invalid.
190   */
191  void setWritabilityMode(WritabilityMode value) throws PropertyException;
192
193}