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