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 LDIF Backend settings. 027 * <p> 028 * The LDIF Backend provides a mechanism for interacting with data 029 * stored in an LDIF file. 030 */ 031public interface LDIFBackendCfg extends BackendCfg { 032 033 /** 034 * Gets the configuration class associated with this LDIF Backend. 035 * 036 * @return Returns the configuration class associated with this LDIF Backend. 037 */ 038 Class<? extends LDIFBackendCfg> configurationClass(); 039 040 041 042 /** 043 * Register to be notified when this LDIF Backend is changed. 044 * 045 * @param listener 046 * The LDIF Backend configuration change listener. 047 */ 048 void addLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener); 049 050 051 052 /** 053 * Deregister an existing LDIF Backend configuration change listener. 054 * 055 * @param listener 056 * The LDIF Backend configuration change listener. 057 */ 058 void removeLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener); 059 060 061 062 /** 063 * Gets the "is-private-backend" property. 064 * <p> 065 * Indicates whether the backend should be considered a private 066 * backend, which indicates that it is used for storing operational 067 * data rather than user-defined information. 068 * 069 * @return Returns the value of the "is-private-backend" property. 070 */ 071 boolean isIsPrivateBackend(); 072 073 074 075 /** 076 * Gets the "java-class" property. 077 * <p> 078 * Specifies the fully-qualified name of the Java class that 079 * provides the backend implementation. 080 * 081 * @return Returns the value of the "java-class" property. 082 */ 083 String getJavaClass(); 084 085 086 087 /** 088 * Gets the "ldif-file" property. 089 * <p> 090 * Specifies the path to the LDIF file containing the data for this 091 * backend. 092 * 093 * @return Returns the value of the "ldif-file" property. 094 */ 095 String getLDIFFile(); 096 097 098 099 /** 100 * Gets the "writability-mode" property. 101 * <p> 102 * Specifies the behavior that the backend should use when 103 * processing write operations. 104 * 105 * @return Returns the value of the "writability-mode" property. 106 */ 107 WritabilityMode getWritabilityMode(); 108 109}