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.server.ConfigurationChangeListener;
032    
033    
034    
035    /**
036     * A server-side interface for querying LDIF Connection Handler
037     * settings.
038     * <p>
039     * The LDIF Connection Handler is used to process changes in the
040     * server using internal operations, where the changes to process are
041     * read from an LDIF file.
042     */
043    public interface LDIFConnectionHandlerCfg extends ConnectionHandlerCfg {
044    
045      /**
046       * Gets the configuration class associated with this LDIF Connection Handler.
047       *
048       * @return Returns the configuration class associated with this LDIF Connection Handler.
049       */
050      Class<? extends LDIFConnectionHandlerCfg> configurationClass();
051    
052    
053    
054      /**
055       * Register to be notified when this LDIF Connection Handler is changed.
056       *
057       * @param listener
058       *          The LDIF Connection Handler configuration change listener.
059       */
060      void addLDIFChangeListener(ConfigurationChangeListener<LDIFConnectionHandlerCfg> listener);
061    
062    
063    
064      /**
065       * Deregister an existing LDIF Connection Handler configuration change listener.
066       *
067       * @param listener
068       *          The LDIF Connection Handler configuration change listener.
069       */
070      void removeLDIFChangeListener(ConfigurationChangeListener<LDIFConnectionHandlerCfg> listener);
071    
072    
073    
074      /**
075       * Gets the "java-class" property.
076       * <p>
077       * Specifies the fully-qualified name of the Java class that
078       * provides the LDIF Connection Handler implementation.
079       *
080       * @return Returns the value of the "java-class" property.
081       */
082      String getJavaClass();
083    
084    
085    
086      /**
087       * Gets the "ldif-directory" property.
088       * <p>
089       * Specifies the path to the directory in which the LDIF files
090       * should be placed.
091       *
092       * @return Returns the value of the "ldif-directory" property.
093       */
094      String getLDIFDirectory();
095    
096    
097    
098      /**
099       * Gets the "poll-interval" property.
100       * <p>
101       * Specifies how frequently the LDIF connection handler should check
102       * the LDIF directory to determine whether a new LDIF file has been
103       * added.
104       *
105       * @return Returns the value of the "poll-interval" property.
106       */
107      long getPollInterval();
108    
109    }