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