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