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.server; 017 018 019 020import org.forgerock.opendj.config.server.ConfigurationChangeListener; 021import org.forgerock.opendj.server.config.meta.BackendCfgDefn.WritabilityMode; 022 023 024 025/** 026 * A server-side interface for querying Task Backend settings. 027 * <p> 028 * The Task Backend provides a mechanism for scheduling tasks in the 029 * OpenDJ directory server. Tasks are intended to provide access to 030 * certain types of administrative functions in the server that may not 031 * be convenient to perform remotely. 032 */ 033public interface TaskBackendCfg extends BackendCfg { 034 035 /** 036 * Gets the configuration class associated with this Task Backend. 037 * 038 * @return Returns the configuration class associated with this Task Backend. 039 */ 040 Class<? extends TaskBackendCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this Task Backend is changed. 046 * 047 * @param listener 048 * The Task Backend configuration change listener. 049 */ 050 void addTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener); 051 052 053 054 /** 055 * Deregister an existing Task Backend configuration change listener. 056 * 057 * @param listener 058 * The Task Backend configuration change listener. 059 */ 060 void removeTaskChangeListener(ConfigurationChangeListener<TaskBackendCfg> listener); 061 062 063 064 /** 065 * Gets the "java-class" property. 066 * <p> 067 * Specifies the fully-qualified name of the Java class that 068 * provides the backend implementation. 069 * 070 * @return Returns the value of the "java-class" property. 071 */ 072 String getJavaClass(); 073 074 075 076 /** 077 * Gets the "notification-sender-address" property. 078 * <p> 079 * Specifies the email address to use as the sender (that is, the 080 * "From:" address) address for notification mail messages generated 081 * when a task completes execution. 082 * 083 * @return Returns the value of the "notification-sender-address" property. 084 */ 085 String getNotificationSenderAddress(); 086 087 088 089 /** 090 * Gets the "task-backing-file" property. 091 * <p> 092 * Specifies the path to the backing file for storing information 093 * about the tasks configured in the server. 094 * <p> 095 * It may be either an absolute path or a relative path to the base 096 * of the OpenDJ directory server instance. 097 * 098 * @return Returns the value of the "task-backing-file" property. 099 */ 100 String getTaskBackingFile(); 101 102 103 104 /** 105 * Gets the "task-retention-time" property. 106 * <p> 107 * Specifies the length of time that task entries should be retained 108 * after processing on the associated task has been completed. 109 * 110 * @return Returns the value of the "task-retention-time" property. 111 */ 112 long getTaskRetentionTime(); 113 114 115 116 /** 117 * Gets the "writability-mode" property. 118 * <p> 119 * Specifies the behavior that the backend should use when 120 * processing write operations. 121 * 122 * @return Returns the value of the "writability-mode" property. 123 */ 124 WritabilityMode getWritabilityMode(); 125 126}