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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.std.client; 028 029 030 031 import org.opends.server.admin.IllegalPropertyValueException; 032 import org.opends.server.admin.ManagedObjectDefinition; 033 import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode; 034 import org.opends.server.admin.std.server.ConfigFileHandlerBackendCfg; 035 036 037 038 /** 039 * A client-side interface for reading and modifying Config File 040 * Handler Backend settings. 041 * <p> 042 * The Config File Handler Backend allows clients to access the server 043 * configuration over protocol, and allow both read and write 044 * operations. Note: Modify DN operations are not supported for entries 045 * in the server configuration. 046 */ 047 public interface ConfigFileHandlerBackendCfgClient extends BackendCfgClient { 048 049 /** 050 * Get the configuration definition associated with this Config File Handler Backend. 051 * 052 * @return Returns the configuration definition associated with this Config File Handler Backend. 053 */ 054 ManagedObjectDefinition<? extends ConfigFileHandlerBackendCfgClient, ? extends ConfigFileHandlerBackendCfg> definition(); 055 056 057 058 /** 059 * Gets the "java-class" property. 060 * <p> 061 * Specifies the fully-qualified name of the Java class that 062 * provides the backend implementation. 063 * 064 * @return Returns the value of the "java-class" property. 065 */ 066 String getJavaClass(); 067 068 069 070 /** 071 * Sets the "java-class" property. 072 * <p> 073 * Specifies the fully-qualified name of the Java class that 074 * provides the backend implementation. 075 * 076 * @param value The value of the "java-class" property. 077 * @throws IllegalPropertyValueException 078 * If the new value is invalid. 079 */ 080 void setJavaClass(String value) throws IllegalPropertyValueException; 081 082 083 084 /** 085 * Gets the "writability-mode" property. 086 * <p> 087 * Specifies the behavior that the backend should use when 088 * processing write operations. 089 * 090 * @return Returns the value of the "writability-mode" property. 091 */ 092 WritabilityMode getWritabilityMode(); 093 094 095 096 /** 097 * Sets the "writability-mode" property. 098 * <p> 099 * Specifies the behavior that the backend should use when 100 * processing write operations. 101 * 102 * @param value The value of the "writability-mode" property. 103 * @throws IllegalPropertyValueException 104 * If the new value is invalid. 105 */ 106 void setWritabilityMode(WritabilityMode value) throws IllegalPropertyValueException; 107 108 }