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