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 org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
033import org.opends.server.admin.std.server.LDIFBackendCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying LDIF Backend
039 * settings.
040 * <p>
041 * The LDIF Backend provides a mechanism for interacting with data
042 * stored in an LDIF file.
043 */
044public interface LDIFBackendCfgClient extends BackendCfgClient {
045
046  /**
047   * Get the configuration definition associated with this LDIF Backend.
048   *
049   * @return Returns the configuration definition associated with this LDIF Backend.
050   */
051  ManagedObjectDefinition<? extends LDIFBackendCfgClient, ? extends LDIFBackendCfg> definition();
052
053
054
055  /**
056   * Gets the "is-private-backend" property.
057   * <p>
058   * Indicates whether the backend should be considered a private
059   * backend, which indicates that it is used for storing operational
060   * data rather than user-defined information.
061   *
062   * @return Returns the value of the "is-private-backend" property.
063   */
064  boolean isIsPrivateBackend();
065
066
067
068  /**
069   * Sets the "is-private-backend" property.
070   * <p>
071   * Indicates whether the backend should be considered a private
072   * backend, which indicates that it is used for storing operational
073   * data rather than user-defined information.
074   *
075   * @param value The value of the "is-private-backend" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setIsPrivateBackend(Boolean value) throws PropertyException;
080
081
082
083  /**
084   * Gets the "java-class" property.
085   * <p>
086   * Specifies the fully-qualified name of the Java class that
087   * provides the backend implementation.
088   *
089   * @return Returns the value of the "java-class" property.
090   */
091  String getJavaClass();
092
093
094
095  /**
096   * Sets the "java-class" property.
097   * <p>
098   * Specifies the fully-qualified name of the Java class that
099   * provides the backend implementation.
100   *
101   * @param value The value of the "java-class" property.
102   * @throws PropertyException
103   *           If the new value is invalid.
104   */
105  void setJavaClass(String value) throws PropertyException;
106
107
108
109  /**
110   * Gets the "ldif-file" property.
111   * <p>
112   * Specifies the path to the LDIF file containing the data for this
113   * backend.
114   *
115   * @return Returns the value of the "ldif-file" property.
116   */
117  String getLDIFFile();
118
119
120
121  /**
122   * Sets the "ldif-file" property.
123   * <p>
124   * Specifies the path to the LDIF file containing the data for this
125   * backend.
126   *
127   * @param value The value of the "ldif-file" property.
128   * @throws PropertyException
129   *           If the new value is invalid.
130   */
131  void setLDIFFile(String value) throws PropertyException;
132
133
134
135  /**
136   * Gets the "writability-mode" property.
137   * <p>
138   * Specifies the behavior that the backend should use when
139   * processing write operations.
140   *
141   * @return Returns the value of the "writability-mode" property.
142   */
143  WritabilityMode getWritabilityMode();
144
145
146
147  /**
148   * Sets the "writability-mode" property.
149   * <p>
150   * Specifies the behavior that the backend should use when
151   * processing write operations.
152   *
153   * @param value The value of the "writability-mode" property.
154   * @throws PropertyException
155   *           If the new value is invalid.
156   */
157  void setWritabilityMode(WritabilityMode value) throws PropertyException;
158
159}