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