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.server; 028 029 030 031 import java.util.SortedSet; 032 import org.opends.server.admin.server.ConfigurationChangeListener; 033 import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode; 034 035 036 037 /** 038 * A server-side interface for querying Backup Backend settings. 039 * <p> 040 * The Backup Backend provides read-only access to the set of backups 041 * that are available for the OpenDS Directory Server. 042 */ 043 public interface BackupBackendCfg extends BackendCfg { 044 045 /** 046 * Gets the configuration class associated with this Backup Backend. 047 * 048 * @return Returns the configuration class associated with this Backup Backend. 049 */ 050 Class<? extends BackupBackendCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this Backup Backend is changed. 056 * 057 * @param listener 058 * The Backup Backend configuration change listener. 059 */ 060 void addBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener); 061 062 063 064 /** 065 * Deregister an existing Backup Backend configuration change listener. 066 * 067 * @param listener 068 * The Backup Backend configuration change listener. 069 */ 070 void removeBackupChangeListener(ConfigurationChangeListener<BackupBackendCfg> listener); 071 072 073 074 /** 075 * Gets the "backup-directory" property. 076 * <p> 077 * Specifies the path to a backup directory containing one or more 078 * backups for a particular backend. 079 * <p> 080 * This is a multivalued property. Each value may specify a 081 * different backup directory if desired (one for each backend for 082 * which backups are taken). Values may be either absolute paths or 083 * paths that are relative to the base of the OpenDS Directory Server 084 * installation. 085 * 086 * @return Returns an unmodifiable set containing the values of the "backup-directory" property. 087 */ 088 SortedSet<String> getBackupDirectory(); 089 090 091 092 /** 093 * Gets the "java-class" property. 094 * <p> 095 * Specifies the fully-qualified name of the Java class that 096 * provides the backend implementation. 097 * 098 * @return Returns the value of the "java-class" property. 099 */ 100 String getJavaClass(); 101 102 103 104 /** 105 * Gets the "writability-mode" property. 106 * <p> 107 * Specifies the behavior that the backend should use when 108 * processing write operations. 109 * 110 * @return Returns the value of the "writability-mode" property. 111 */ 112 WritabilityMode getWritabilityMode(); 113 114 }