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