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