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.client; 017 018 019 020import org.forgerock.opendj.config.ManagedObjectDefinition; 021import org.forgerock.opendj.config.PropertyException; 022import org.forgerock.opendj.server.config.server.ExternalAccessLogPublisherCfg; 023 024 025 026/** 027 * A client-side interface for reading and modifying External Access 028 * Log Publisher settings. 029 * <p> 030 * External Access Log Publishers publish access messages to an 031 * external handler. 032 */ 033public interface ExternalAccessLogPublisherCfgClient extends AccessLogPublisherCfgClient { 034 035 /** 036 * Get the configuration definition associated with this External Access Log Publisher. 037 * 038 * @return Returns the configuration definition associated with this External Access Log Publisher. 039 */ 040 ManagedObjectDefinition<? extends ExternalAccessLogPublisherCfgClient, ? extends ExternalAccessLogPublisherCfg> definition(); 041 042 043 044 /** 045 * Gets the "config-file" property. 046 * <p> 047 * The JSON configuration file that defines the External Access Log 048 * Publisher. The content of the JSON configuration file depends on 049 * the type of external audit event handler. The path to the file is 050 * relative to the server root. 051 * 052 * @return Returns the value of the "config-file" property. 053 */ 054 String getConfigFile(); 055 056 057 058 /** 059 * Sets the "config-file" property. 060 * <p> 061 * The JSON configuration file that defines the External Access Log 062 * Publisher. The content of the JSON configuration file depends on 063 * the type of external audit event handler. The path to the file is 064 * relative to the server root. 065 * 066 * @param value The value of the "config-file" property. 067 * @throws PropertyException 068 * If the new value is invalid. 069 */ 070 void setConfigFile(String value) throws PropertyException; 071 072 073 074 /** 075 * Gets the "java-class" property. 076 * <p> 077 * The fully-qualified name of the Java class that provides the 078 * External Access Log Publisher implementation. 079 * 080 * @return Returns the value of the "java-class" property. 081 */ 082 String getJavaClass(); 083 084 085 086 /** 087 * Sets the "java-class" property. 088 * <p> 089 * The fully-qualified name of the Java class that provides the 090 * External Access Log Publisher implementation. 091 * 092 * @param value The value of the "java-class" property. 093 * @throws PropertyException 094 * If the new value is invalid. 095 */ 096 void setJavaClass(String value) throws PropertyException; 097 098 099 100 /** 101 * Gets the "log-control-oids" property. 102 * <p> 103 * Specifies whether control OIDs will be included in operation log 104 * records. 105 * 106 * @return Returns the value of the "log-control-oids" property. 107 */ 108 boolean isLogControlOids(); 109 110 111 112 /** 113 * Sets the "log-control-oids" property. 114 * <p> 115 * Specifies whether control OIDs will be included in operation log 116 * records. 117 * 118 * @param value The value of the "log-control-oids" property. 119 * @throws PropertyException 120 * If the new value is invalid. 121 */ 122 void setLogControlOids(Boolean value) throws PropertyException; 123 124}