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