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.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.meta.BackendCfgDefn.WritabilityMode; 023import org.forgerock.opendj.server.config.server.MemoryBackendCfg; 024 025 026 027/** 028 * A client-side interface for reading and modifying Memory Backend 029 * settings. 030 * <p> 031 * The Memory Backend provides a directory server backend 032 * implementation that stores entries in memory. 033 */ 034public interface MemoryBackendCfgClient extends BackendCfgClient { 035 036 /** 037 * Get the configuration definition associated with this Memory Backend. 038 * 039 * @return Returns the configuration definition associated with this Memory Backend. 040 */ 041 ManagedObjectDefinition<? extends MemoryBackendCfgClient, ? extends MemoryBackendCfg> definition(); 042 043 044 045 /** 046 * Gets the "java-class" property. 047 * <p> 048 * Specifies the fully-qualified name of the Java class that 049 * provides the backend implementation. 050 * 051 * @return Returns the value of the "java-class" property. 052 */ 053 String getJavaClass(); 054 055 056 057 /** 058 * Sets the "java-class" property. 059 * <p> 060 * Specifies the fully-qualified name of the Java class that 061 * provides the backend implementation. 062 * 063 * @param value The value of the "java-class" property. 064 * @throws PropertyException 065 * If the new value is invalid. 066 */ 067 void setJavaClass(String value) throws PropertyException; 068 069 070 071 /** 072 * Gets the "writability-mode" property. 073 * <p> 074 * Specifies the behavior that the backend should use when 075 * processing write operations. 076 * 077 * @return Returns the value of the "writability-mode" property. 078 */ 079 WritabilityMode getWritabilityMode(); 080 081 082 083 /** 084 * Sets the "writability-mode" property. 085 * <p> 086 * Specifies the behavior that the backend should use when 087 * processing write operations. 088 * 089 * @param value The value of the "writability-mode" property. 090 * @throws PropertyException 091 * If the new value is invalid. 092 */ 093 void setWritabilityMode(WritabilityMode value) throws PropertyException; 094 095}