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