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