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.server;
028    
029    
030    
031    import org.opends.server.admin.server.ConfigurationChangeListener;
032    import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
033    
034    
035    
036    /**
037     * A server-side interface for querying LDIF Backend settings.
038     * <p>
039     * The LDIF Backend provides a mechanism for interacting with data
040     * stored in an LDIF file.
041     */
042    public interface LDIFBackendCfg extends BackendCfg {
043    
044      /**
045       * Gets the configuration class associated with this LDIF Backend.
046       *
047       * @return Returns the configuration class associated with this LDIF Backend.
048       */
049      Class<? extends LDIFBackendCfg> configurationClass();
050    
051    
052    
053      /**
054       * Register to be notified when this LDIF Backend is changed.
055       *
056       * @param listener
057       *          The LDIF Backend configuration change listener.
058       */
059      void addLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener);
060    
061    
062    
063      /**
064       * Deregister an existing LDIF Backend configuration change listener.
065       *
066       * @param listener
067       *          The LDIF Backend configuration change listener.
068       */
069      void removeLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener);
070    
071    
072    
073      /**
074       * Gets the "is-private-backend" property.
075       * <p>
076       * Indicates whether the backend should be considered a private
077       * backend, which indicates that it is used for storing operational
078       * data rather than user-defined information.
079       *
080       * @return Returns the value of the "is-private-backend" property.
081       */
082      boolean isIsPrivateBackend();
083    
084    
085    
086      /**
087       * Gets the "java-class" property.
088       * <p>
089       * Specifies the fully-qualified name of the Java class that
090       * provides the backend implementation.
091       *
092       * @return Returns the value of the "java-class" property.
093       */
094      String getJavaClass();
095    
096    
097    
098      /**
099       * Gets the "ldif-file" property.
100       * <p>
101       * Specifies the path to the LDIF file containing the data for this
102       * backend.
103       *
104       * @return Returns the value of the "ldif-file" property.
105       */
106      String getLDIFFile();
107    
108    
109    
110      /**
111       * Gets the "writability-mode" property.
112       * <p>
113       * Specifies the behavior that the backend should use when
114       * processing write operations.
115       *
116       * @return Returns the value of the "writability-mode" property.
117       */
118      WritabilityMode getWritabilityMode();
119    
120    }