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 010 * trunk/opends/resource/legal-notices/OpenDS.LICENSE 011 * or https://OpenDS.dev.java.net/OpenDS.LICENSE. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2008 Sun Microsystems, Inc. 026 */ 027 package org.opends.server.admin.std.server; 028 029 030 031 import org.opends.server.admin.Configuration; 032 import org.opends.server.admin.server.ConfigurationChangeListener; 033 034 035 036 /** 037 * A server-side interface for querying Synchronization Provider 038 * settings. 039 * <p> 040 * Synchronization Providers are responsible for handling 041 * synchronization of the Directory Server data with other OpenDS 042 * instances or other data repositories. 043 */ 044 public interface SynchronizationProviderCfg extends Configuration { 045 046 /** 047 * Gets the configuration class associated with this Synchronization Provider. 048 * 049 * @return Returns the configuration class associated with this Synchronization Provider. 050 */ 051 Class<? extends SynchronizationProviderCfg> configurationClass(); 052 053 054 055 /** 056 * Register to be notified when this Synchronization Provider is changed. 057 * 058 * @param listener 059 * The Synchronization Provider configuration change listener. 060 */ 061 void addChangeListener(ConfigurationChangeListener<SynchronizationProviderCfg> listener); 062 063 064 065 /** 066 * Deregister an existing Synchronization Provider configuration change listener. 067 * 068 * @param listener 069 * The Synchronization Provider configuration change listener. 070 */ 071 void removeChangeListener(ConfigurationChangeListener<SynchronizationProviderCfg> listener); 072 073 074 075 /** 076 * Gets the "enabled" property. 077 * <p> 078 * Indicates whether the Synchronization Provider is enabled for 079 * use. 080 * 081 * @return Returns the value of the "enabled" property. 082 */ 083 boolean isEnabled(); 084 085 086 087 /** 088 * Gets the "java-class" property. 089 * <p> 090 * Specifies the fully-qualified name of the Java class that 091 * provides the Synchronization Provider implementation. 092 * 093 * @return Returns the value of the "java-class" property. 094 */ 095 String getJavaClass(); 096 097 }