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.server; 017 018 019 020import org.forgerock.opendj.config.Configuration; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022 023 024 025/** 026 * A server-side interface for querying Schema Provider settings. 027 * <p> 028 * Schema Providers define the schema elements to load. 029 */ 030public interface SchemaProviderCfg extends Configuration { 031 032 /** 033 * Gets the configuration class associated with this Schema Provider. 034 * 035 * @return Returns the configuration class associated with this Schema Provider. 036 */ 037 Class<? extends SchemaProviderCfg> configurationClass(); 038 039 040 041 /** 042 * Register to be notified when this Schema Provider is changed. 043 * 044 * @param listener 045 * The Schema Provider configuration change listener. 046 */ 047 void addChangeListener(ConfigurationChangeListener<SchemaProviderCfg> listener); 048 049 050 051 /** 052 * Deregister an existing Schema Provider configuration change listener. 053 * 054 * @param listener 055 * The Schema Provider configuration change listener. 056 */ 057 void removeChangeListener(ConfigurationChangeListener<SchemaProviderCfg> listener); 058 059 060 061 /** 062 * Gets the "enabled" property. 063 * <p> 064 * Indicates whether the Schema Provider is enabled for use. 065 * 066 * @return Returns the value of the "enabled" property. 067 */ 068 boolean isEnabled(); 069 070 071 072 /** 073 * Gets the "java-class" property. 074 * <p> 075 * Specifies the fully-qualified name of the Java class that 076 * provides the Schema Provider implementation. 077 * 078 * @return Returns the value of the "java-class" property. 079 */ 080 String getJavaClass(); 081 082}