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