001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions Copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2008 Sun Microsystems, Inc.
015 */
016package org.opends.server.admin.std.server;
017
018
019
020import org.opends.server.admin.server.ConfigurationChangeListener;
021import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
022
023
024
025/**
026 * A server-side interface for querying Config File Handler Backend
027 * settings.
028 * <p>
029 * The Config File Handler Backend allows clients to access the server
030 * configuration over protocol, and allow both read and write
031 * operations. Note: Modify DN operations are not supported for entries
032 * in the server configuration.
033 */
034public interface ConfigFileHandlerBackendCfg extends BackendCfg {
035
036  /**
037   * Gets the configuration class associated with this Config File Handler Backend.
038   *
039   * @return Returns the configuration class associated with this Config File Handler Backend.
040   */
041  Class<? extends ConfigFileHandlerBackendCfg> configurationClass();
042
043
044
045  /**
046   * Register to be notified when this Config File Handler Backend is changed.
047   *
048   * @param listener
049   *          The Config File Handler Backend configuration change listener.
050   */
051  void addConfigFileHandlerChangeListener(ConfigurationChangeListener<ConfigFileHandlerBackendCfg> listener);
052
053
054
055  /**
056   * Deregister an existing Config File Handler Backend configuration change listener.
057   *
058   * @param listener
059   *          The Config File Handler Backend configuration change listener.
060   */
061  void removeConfigFileHandlerChangeListener(ConfigurationChangeListener<ConfigFileHandlerBackendCfg> listener);
062
063
064
065  /**
066   * Gets the "java-class" property.
067   * <p>
068   * Specifies the fully-qualified name of the Java class that
069   * provides the backend implementation.
070   *
071   * @return Returns the value of the "java-class" property.
072   */
073  String getJavaClass();
074
075
076
077  /**
078   * Gets the "writability-mode" property.
079   * <p>
080   * Specifies the behavior that the backend should use when
081   * processing write operations.
082   *
083   * @return Returns the value of the "writability-mode" property.
084   */
085  WritabilityMode getWritabilityMode();
086
087}