001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import org.opends.server.admin.server.ConfigurationChangeListener; 031import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode; 032 033 034 035/** 036 * A server-side interface for querying LDIF Backend settings. 037 * <p> 038 * The LDIF Backend provides a mechanism for interacting with data 039 * stored in an LDIF file. 040 */ 041public interface LDIFBackendCfg extends BackendCfg { 042 043 /** 044 * Gets the configuration class associated with this LDIF Backend. 045 * 046 * @return Returns the configuration class associated with this LDIF Backend. 047 */ 048 Class<? extends LDIFBackendCfg> configurationClass(); 049 050 051 052 /** 053 * Register to be notified when this LDIF Backend is changed. 054 * 055 * @param listener 056 * The LDIF Backend configuration change listener. 057 */ 058 void addLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener); 059 060 061 062 /** 063 * Deregister an existing LDIF Backend configuration change listener. 064 * 065 * @param listener 066 * The LDIF Backend configuration change listener. 067 */ 068 void removeLDIFChangeListener(ConfigurationChangeListener<LDIFBackendCfg> listener); 069 070 071 072 /** 073 * Gets the "is-private-backend" property. 074 * <p> 075 * Indicates whether the backend should be considered a private 076 * backend, which indicates that it is used for storing operational 077 * data rather than user-defined information. 078 * 079 * @return Returns the value of the "is-private-backend" property. 080 */ 081 boolean isIsPrivateBackend(); 082 083 084 085 /** 086 * Gets the "java-class" property. 087 * <p> 088 * Specifies the fully-qualified name of the Java class that 089 * provides the backend implementation. 090 * 091 * @return Returns the value of the "java-class" property. 092 */ 093 String getJavaClass(); 094 095 096 097 /** 098 * Gets the "ldif-file" property. 099 * <p> 100 * Specifies the path to the LDIF file containing the data for this 101 * backend. 102 * 103 * @return Returns the value of the "ldif-file" property. 104 */ 105 String getLDIFFile(); 106 107 108 109 /** 110 * Gets the "writability-mode" property. 111 * <p> 112 * Specifies the behavior that the backend should use when 113 * processing write operations. 114 * 115 * @return Returns the value of the "writability-mode" property. 116 */ 117 WritabilityMode getWritabilityMode(); 118 119}