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.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.server.SchemaProviderCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Schema Provider
039 * settings.
040 * <p>
041 * Schema Providers define the schema elements to load.
042 */
043public interface SchemaProviderCfgClient extends ConfigurationClient {
044
045  /**
046   * Get the configuration definition associated with this Schema Provider.
047   *
048   * @return Returns the configuration definition associated with this Schema Provider.
049   */
050  ManagedObjectDefinition<? extends SchemaProviderCfgClient, ? extends SchemaProviderCfg> definition();
051
052
053
054  /**
055   * Gets the "enabled" property.
056   * <p>
057   * Indicates whether the Schema Provider is enabled for use.
058   *
059   * @return Returns the value of the "enabled" property.
060   */
061  Boolean isEnabled();
062
063
064
065  /**
066   * Sets the "enabled" property.
067   * <p>
068   * Indicates whether the Schema Provider is enabled for use.
069   *
070   * @param value The value of the "enabled" property.
071   * @throws PropertyException
072   *           If the new value is invalid.
073   */
074  void setEnabled(boolean value) throws PropertyException;
075
076
077
078  /**
079   * Gets the "java-class" property.
080   * <p>
081   * Specifies the fully-qualified name of the Java class that
082   * provides the Schema Provider implementation.
083   *
084   * @return Returns the value of the "java-class" property.
085   */
086  String getJavaClass();
087
088
089
090  /**
091   * Sets the "java-class" property.
092   * <p>
093   * Specifies the fully-qualified name of the Java class that
094   * provides the Schema Provider implementation.
095   *
096   * @param value The value of the "java-class" property.
097   * @throws PropertyException
098   *           If the new value is invalid.
099   */
100  void setJavaClass(String value) throws PropertyException;
101
102}