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