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.AccessLogPublisherCfg; 034 035 036 037 /** 038 * A client-side interface for reading and modifying Access Log 039 * Publisher settings. 040 * <p> 041 * Access Log Publishers are responsible for distributing access log 042 * messages from the access logger to a destination. 043 */ 044 public interface AccessLogPublisherCfgClient extends LogPublisherCfgClient { 045 046 /** 047 * Get the configuration definition associated with this Access Log Publisher. 048 * 049 * @return Returns the configuration definition associated with this Access Log Publisher. 050 */ 051 ManagedObjectDefinition<? extends AccessLogPublisherCfgClient, ? extends AccessLogPublisherCfg> definition(); 052 053 054 055 /** 056 * Gets the "java-class" property. 057 * <p> 058 * The fully-qualified name of the Java class that provides the 059 * Access Log Publisher implementation. 060 * 061 * @return Returns the value of the "java-class" property. 062 */ 063 String getJavaClass(); 064 065 066 067 /** 068 * Sets the "java-class" property. 069 * <p> 070 * The fully-qualified name of the Java class that provides the 071 * Access Log Publisher implementation. 072 * 073 * @param value The value of the "java-class" property. 074 * @throws IllegalPropertyValueException 075 * If the new value is invalid. 076 */ 077 void setJavaClass(String value) throws IllegalPropertyValueException; 078 079 080 081 /** 082 * Gets the "suppress-internal-operations" property. 083 * <p> 084 * Indicates whether internal operations (for example, operations 085 * that are initiated by plugins) should be logged along with the 086 * operations that are requested by users. 087 * 088 * @return Returns the value of the "suppress-internal-operations" property. 089 */ 090 boolean isSuppressInternalOperations(); 091 092 093 094 /** 095 * Sets the "suppress-internal-operations" property. 096 * <p> 097 * Indicates whether internal operations (for example, operations 098 * that are initiated by plugins) should be logged along with the 099 * operations that are requested by users. 100 * 101 * @param value The value of the "suppress-internal-operations" property. 102 * @throws IllegalPropertyValueException 103 * If the new value is invalid. 104 */ 105 void setSuppressInternalOperations(Boolean value) throws IllegalPropertyValueException; 106 107 108 109 /** 110 * Gets the "suppress-synchronization-operations" property. 111 * <p> 112 * Indicates whether access messages that are generated by 113 * synchronization operations should be suppressed. 114 * 115 * @return Returns the value of the "suppress-synchronization-operations" property. 116 */ 117 boolean isSuppressSynchronizationOperations(); 118 119 120 121 /** 122 * Sets the "suppress-synchronization-operations" property. 123 * <p> 124 * Indicates whether access messages that are generated by 125 * synchronization operations should be suppressed. 126 * 127 * @param value The value of the "suppress-synchronization-operations" property. 128 * @throws IllegalPropertyValueException 129 * If the new value is invalid. 130 */ 131 void setSuppressSynchronizationOperations(Boolean value) throws IllegalPropertyValueException; 132 133 }