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 Config File Handler Backend
038     * settings.
039     * <p>
040     * The Config File Handler Backend allows clients to access the server
041     * configuration over protocol, and allow both read and write
042     * operations. Note: Modify DN operations are not supported for entries
043     * in the server configuration.
044     */
045    public interface ConfigFileHandlerBackendCfg extends BackendCfg {
046    
047      /**
048       * Gets the configuration class associated with this Config File Handler Backend.
049       *
050       * @return Returns the configuration class associated with this Config File Handler Backend.
051       */
052      Class<? extends ConfigFileHandlerBackendCfg> configurationClass();
053    
054    
055    
056      /**
057       * Register to be notified when this Config File Handler Backend is changed.
058       *
059       * @param listener
060       *          The Config File Handler Backend configuration change listener.
061       */
062      void addConfigFileHandlerChangeListener(ConfigurationChangeListener<ConfigFileHandlerBackendCfg> listener);
063    
064    
065    
066      /**
067       * Deregister an existing Config File Handler Backend configuration change listener.
068       *
069       * @param listener
070       *          The Config File Handler Backend configuration change listener.
071       */
072      void removeConfigFileHandlerChangeListener(ConfigurationChangeListener<ConfigFileHandlerBackendCfg> listener);
073    
074    
075    
076      /**
077       * Gets the "java-class" property.
078       * <p>
079       * Specifies the fully-qualified name of the Java class that
080       * provides the backend implementation.
081       *
082       * @return Returns the value of the "java-class" property.
083       */
084      String getJavaClass();
085    
086    
087    
088      /**
089       * Gets the "writability-mode" property.
090       * <p>
091       * Specifies the behavior that the backend should use when
092       * processing write operations.
093       *
094       * @return Returns the value of the "writability-mode" property.
095       */
096      WritabilityMode getWritabilityMode();
097    
098    }