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