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.client;
027
028
029
030import java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
035import org.opends.server.admin.std.server.BackupBackendCfg;
036
037
038
039/**
040 * A client-side interface for reading and modifying Backup Backend
041 * settings.
042 * <p>
043 * The Backup Backend provides read-only access to the set of backups
044 * that are available for OpenDJ.
045 */
046public interface BackupBackendCfgClient extends BackendCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Backup Backend.
050   *
051   * @return Returns the configuration definition associated with this Backup Backend.
052   */
053  ManagedObjectDefinition<? extends BackupBackendCfgClient, ? extends BackupBackendCfg> definition();
054
055
056
057  /**
058   * Gets the "backup-directory" property.
059   * <p>
060   * Specifies the path to a backup directory containing one or more
061   * backups for a particular backend.
062   * <p>
063   * This is a multivalued property. Each value may specify a
064   * different backup directory if desired (one for each backend for
065   * which backups are taken). Values may be either absolute paths or
066   * paths that are relative to the base of the OpenDJ directory server
067   * installation.
068   *
069   * @return Returns the values of the "backup-directory" property.
070   */
071  SortedSet<String> getBackupDirectory();
072
073
074
075  /**
076   * Sets the "backup-directory" property.
077   * <p>
078   * Specifies the path to a backup directory containing one or more
079   * backups for a particular backend.
080   * <p>
081   * This is a multivalued property. Each value may specify a
082   * different backup directory if desired (one for each backend for
083   * which backups are taken). Values may be either absolute paths or
084   * paths that are relative to the base of the OpenDJ directory server
085   * installation.
086   *
087   * @param values The values of the "backup-directory" property.
088   * @throws PropertyException
089   *           If one or more of the new values are invalid.
090   */
091  void setBackupDirectory(Collection<String> values) throws PropertyException;
092
093
094
095  /**
096   * Gets the "java-class" property.
097   * <p>
098   * Specifies the fully-qualified name of the Java class that
099   * provides the backend implementation.
100   *
101   * @return Returns the value of the "java-class" property.
102   */
103  String getJavaClass();
104
105
106
107  /**
108   * Sets the "java-class" property.
109   * <p>
110   * Specifies the fully-qualified name of the Java class that
111   * provides the backend implementation.
112   *
113   * @param value The value of the "java-class" property.
114   * @throws PropertyException
115   *           If the new value is invalid.
116   */
117  void setJavaClass(String value) throws PropertyException;
118
119
120
121  /**
122   * Gets the "writability-mode" property.
123   * <p>
124   * Specifies the behavior that the backend should use when
125   * processing write operations.
126   *
127   * @return Returns the value of the "writability-mode" property.
128   */
129  WritabilityMode getWritabilityMode();
130
131
132
133  /**
134   * Sets the "writability-mode" property.
135   * <p>
136   * Specifies the behavior that the backend should use when
137   * processing write operations.
138   *
139   * @param value The value of the "writability-mode" property.
140   * @throws PropertyException
141   *           If the new value is invalid.
142   */
143  void setWritabilityMode(WritabilityMode value) throws PropertyException;
144
145}