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.LDIFBackendCfg; 024 025 026 027/** 028 * A client-side interface for reading and modifying LDIF Backend 029 * settings. 030 * <p> 031 * The LDIF Backend provides a mechanism for interacting with data 032 * stored in an LDIF file. 033 */ 034public interface LDIFBackendCfgClient extends BackendCfgClient { 035 036 /** 037 * Get the configuration definition associated with this LDIF Backend. 038 * 039 * @return Returns the configuration definition associated with this LDIF Backend. 040 */ 041 ManagedObjectDefinition<? extends LDIFBackendCfgClient, ? extends LDIFBackendCfg> definition(); 042 043 044 045 /** 046 * Gets the "is-private-backend" property. 047 * <p> 048 * Indicates whether the backend should be considered a private 049 * backend, which indicates that it is used for storing operational 050 * data rather than user-defined information. 051 * 052 * @return Returns the value of the "is-private-backend" property. 053 */ 054 boolean isIsPrivateBackend(); 055 056 057 058 /** 059 * Sets the "is-private-backend" property. 060 * <p> 061 * Indicates whether the backend should be considered a private 062 * backend, which indicates that it is used for storing operational 063 * data rather than user-defined information. 064 * 065 * @param value The value of the "is-private-backend" property. 066 * @throws PropertyException 067 * If the new value is invalid. 068 */ 069 void setIsPrivateBackend(Boolean value) throws PropertyException; 070 071 072 073 /** 074 * Gets the "java-class" property. 075 * <p> 076 * Specifies the fully-qualified name of the Java class that 077 * provides the backend implementation. 078 * 079 * @return Returns the value of the "java-class" property. 080 */ 081 String getJavaClass(); 082 083 084 085 /** 086 * Sets the "java-class" property. 087 * <p> 088 * Specifies the fully-qualified name of the Java class that 089 * provides the backend implementation. 090 * 091 * @param value The value of the "java-class" property. 092 * @throws PropertyException 093 * If the new value is invalid. 094 */ 095 void setJavaClass(String value) throws PropertyException; 096 097 098 099 /** 100 * Gets the "ldif-file" property. 101 * <p> 102 * Specifies the path to the LDIF file containing the data for this 103 * backend. 104 * 105 * @return Returns the value of the "ldif-file" property. 106 */ 107 String getLDIFFile(); 108 109 110 111 /** 112 * Sets the "ldif-file" property. 113 * <p> 114 * Specifies the path to the LDIF file containing the data for this 115 * backend. 116 * 117 * @param value The value of the "ldif-file" property. 118 * @throws PropertyException 119 * If the new value is invalid. 120 */ 121 void setLDIFFile(String value) throws PropertyException; 122 123 124 125 /** 126 * Gets the "writability-mode" property. 127 * <p> 128 * Specifies the behavior that the backend should use when 129 * processing write operations. 130 * 131 * @return Returns the value of the "writability-mode" property. 132 */ 133 WritabilityMode getWritabilityMode(); 134 135 136 137 /** 138 * Sets the "writability-mode" property. 139 * <p> 140 * Specifies the behavior that the backend should use when 141 * processing write operations. 142 * 143 * @param value The value of the "writability-mode" property. 144 * @throws PropertyException 145 * If the new value is invalid. 146 */ 147 void setWritabilityMode(WritabilityMode value) throws PropertyException; 148 149}