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.server; 027 028 029 030import org.opends.server.admin.Configuration; 031import org.opends.server.admin.server.ConfigurationChangeListener; 032 033 034 035/** 036 * A server-side interface for querying Synchronization Provider 037 * settings. 038 * <p> 039 * Synchronization Providers are responsible for handling 040 * synchronization of the directory server data with other OpenDJ 041 * instances or other data repositories. 042 */ 043public interface SynchronizationProviderCfg extends Configuration { 044 045 /** 046 * Gets the configuration class associated with this Synchronization Provider. 047 * 048 * @return Returns the configuration class associated with this Synchronization Provider. 049 */ 050 Class<? extends SynchronizationProviderCfg> configurationClass(); 051 052 053 054 /** 055 * Register to be notified when this Synchronization Provider is changed. 056 * 057 * @param listener 058 * The Synchronization Provider configuration change listener. 059 */ 060 void addChangeListener(ConfigurationChangeListener<SynchronizationProviderCfg> listener); 061 062 063 064 /** 065 * Deregister an existing Synchronization Provider configuration change listener. 066 * 067 * @param listener 068 * The Synchronization Provider configuration change listener. 069 */ 070 void removeChangeListener(ConfigurationChangeListener<SynchronizationProviderCfg> listener); 071 072 073 074 /** 075 * Gets the "enabled" property. 076 * <p> 077 * Indicates whether the Synchronization Provider is enabled for 078 * use. 079 * 080 * @return Returns the value of the "enabled" property. 081 */ 082 boolean isEnabled(); 083 084 085 086 /** 087 * Gets the "java-class" property. 088 * <p> 089 * Specifies the fully-qualified name of the Java class that 090 * provides the Synchronization Provider implementation. 091 * 092 * @return Returns the value of the "java-class" property. 093 */ 094 String getJavaClass(); 095 096}