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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.meta.BackendCfgDefn.WritabilityMode;
033import org.opends.server.admin.std.server.ConfigFileHandlerBackendCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Config File
039 * Handler Backend settings.
040 * <p>
041 * The Config File Handler Backend allows clients to access the server
042 * configuration over protocol, and allow both read and write
043 * operations. Note: Modify DN operations are not supported for entries
044 * in the server configuration.
045 */
046public interface ConfigFileHandlerBackendCfgClient extends BackendCfgClient {
047
048  /**
049   * Get the configuration definition associated with this Config File Handler Backend.
050   *
051   * @return Returns the configuration definition associated with this Config File Handler Backend.
052   */
053  ManagedObjectDefinition<? extends ConfigFileHandlerBackendCfgClient, ? extends ConfigFileHandlerBackendCfg> definition();
054
055
056
057  /**
058   * Gets the "java-class" property.
059   * <p>
060   * Specifies the fully-qualified name of the Java class that
061   * provides the backend implementation.
062   *
063   * @return Returns the value of the "java-class" property.
064   */
065  String getJavaClass();
066
067
068
069  /**
070   * Sets the "java-class" property.
071   * <p>
072   * Specifies the fully-qualified name of the Java class that
073   * provides the backend implementation.
074   *
075   * @param value The value of the "java-class" property.
076   * @throws PropertyException
077   *           If the new value is invalid.
078   */
079  void setJavaClass(String value) throws PropertyException;
080
081
082
083  /**
084   * Gets the "writability-mode" property.
085   * <p>
086   * Specifies the behavior that the backend should use when
087   * processing write operations.
088   *
089   * @return Returns the value of the "writability-mode" property.
090   */
091  WritabilityMode getWritabilityMode();
092
093
094
095  /**
096   * Sets the "writability-mode" property.
097   * <p>
098   * Specifies the behavior that the backend should use when
099   * processing write operations.
100   *
101   * @param value The value of the "writability-mode" property.
102   * @throws PropertyException
103   *           If the new value is invalid.
104   */
105  void setWritabilityMode(WritabilityMode value) throws PropertyException;
106
107}