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.forgerock.opendj.server.config.server;
017
018
019
020import org.forgerock.opendj.config.server.ConfigurationChangeListener;
021import org.forgerock.opendj.server.config.meta.BackendCfgDefn.WritabilityMode;
022
023
024
025/**
026 * A server-side interface for querying Memory Backend settings.
027 * <p>
028 * The Memory Backend provides a directory server backend
029 * implementation that stores entries in memory.
030 */
031public interface MemoryBackendCfg extends BackendCfg {
032
033  /**
034   * Gets the configuration class associated with this Memory Backend.
035   *
036   * @return Returns the configuration class associated with this Memory Backend.
037   */
038  Class<? extends MemoryBackendCfg> configurationClass();
039
040
041
042  /**
043   * Register to be notified when this Memory Backend is changed.
044   *
045   * @param listener
046   *          The Memory Backend configuration change listener.
047   */
048  void addMemoryChangeListener(ConfigurationChangeListener<MemoryBackendCfg> listener);
049
050
051
052  /**
053   * Deregister an existing Memory Backend configuration change listener.
054   *
055   * @param listener
056   *          The Memory Backend configuration change listener.
057   */
058  void removeMemoryChangeListener(ConfigurationChangeListener<MemoryBackendCfg> listener);
059
060
061
062  /**
063   * Gets the "java-class" property.
064   * <p>
065   * Specifies the fully-qualified name of the Java class that
066   * provides the backend implementation.
067   *
068   * @return Returns the value of the "java-class" property.
069   */
070  String getJavaClass();
071
072
073
074  /**
075   * Gets the "writability-mode" property.
076   * <p>
077   * Specifies the behavior that the backend should use when
078   * processing write operations.
079   *
080   * @return Returns the value of the "writability-mode" property.
081   */
082  WritabilityMode getWritabilityMode();
083
084}