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