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