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.client;
027
028
029
030import org.opends.server.admin.ManagedObjectDefinition;
031import org.opends.server.admin.PropertyException;
032import org.opends.server.admin.std.server.LDIFConnectionHandlerCfg;
033
034
035
036/**
037 * A client-side interface for reading and modifying LDIF Connection
038 * Handler settings.
039 * <p>
040 * The LDIF Connection Handler is used to process changes in the
041 * server using internal operations, where the changes to process are
042 * read from an LDIF file.
043 */
044public interface LDIFConnectionHandlerCfgClient extends ConnectionHandlerCfgClient {
045
046  /**
047   * Get the configuration definition associated with this LDIF Connection Handler.
048   *
049   * @return Returns the configuration definition associated with this LDIF Connection Handler.
050   */
051  ManagedObjectDefinition<? extends LDIFConnectionHandlerCfgClient, ? extends LDIFConnectionHandlerCfg> definition();
052
053
054
055  /**
056   * Gets the "java-class" property.
057   * <p>
058   * Specifies the fully-qualified name of the Java class that
059   * provides the LDIF Connection Handler implementation.
060   *
061   * @return Returns the value of the "java-class" property.
062   */
063  String getJavaClass();
064
065
066
067  /**
068   * Sets the "java-class" property.
069   * <p>
070   * Specifies the fully-qualified name of the Java class that
071   * provides the LDIF Connection Handler implementation.
072   *
073   * @param value The value of the "java-class" property.
074   * @throws PropertyException
075   *           If the new value is invalid.
076   */
077  void setJavaClass(String value) throws PropertyException;
078
079
080
081  /**
082   * Gets the "ldif-directory" property.
083   * <p>
084   * Specifies the path to the directory in which the LDIF files
085   * should be placed.
086   *
087   * @return Returns the value of the "ldif-directory" property.
088   */
089  String getLDIFDirectory();
090
091
092
093  /**
094   * Sets the "ldif-directory" property.
095   * <p>
096   * Specifies the path to the directory in which the LDIF files
097   * should be placed.
098   *
099   * @param value The value of the "ldif-directory" property.
100   * @throws PropertyException
101   *           If the new value is invalid.
102   */
103  void setLDIFDirectory(String value) throws PropertyException;
104
105
106
107  /**
108   * Gets the "poll-interval" property.
109   * <p>
110   * Specifies how frequently the LDIF connection handler should check
111   * the LDIF directory to determine whether a new LDIF file has been
112   * added.
113   *
114   * @return Returns the value of the "poll-interval" property.
115   */
116  long getPollInterval();
117
118
119
120  /**
121   * Sets the "poll-interval" property.
122   * <p>
123   * Specifies how frequently the LDIF connection handler should check
124   * the LDIF directory to determine whether a new LDIF file has been
125   * added.
126   *
127   * @param value The value of the "poll-interval" property.
128   * @throws PropertyException
129   *           If the new value is invalid.
130   */
131  void setPollInterval(long value) throws PropertyException;
132
133}