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.forgerock.opendj.server.config.server;
027
028
029
030import org.forgerock.opendj.config.server.ConfigurationChangeListener;
031
032
033
034/**
035 * A server-side interface for querying External Access Log Publisher
036 * settings.
037 * <p>
038 * External Access Log Publishers publish access messages to an
039 * external handler.
040 */
041public interface ExternalAccessLogPublisherCfg extends AccessLogPublisherCfg {
042
043  /**
044   * Gets the configuration class associated with this External Access Log Publisher.
045   *
046   * @return Returns the configuration class associated with this External Access Log Publisher.
047   */
048  Class<? extends ExternalAccessLogPublisherCfg> configurationClass();
049
050
051
052  /**
053   * Register to be notified when this External Access Log Publisher is changed.
054   *
055   * @param listener
056   *          The External Access Log Publisher configuration change listener.
057   */
058  void addExternalAccessChangeListener(ConfigurationChangeListener<ExternalAccessLogPublisherCfg> listener);
059
060
061
062  /**
063   * Deregister an existing External Access Log Publisher configuration change listener.
064   *
065   * @param listener
066   *          The External Access Log Publisher configuration change listener.
067   */
068  void removeExternalAccessChangeListener(ConfigurationChangeListener<ExternalAccessLogPublisherCfg> listener);
069
070
071
072  /**
073   * Gets the "config-file" property.
074   * <p>
075   * The JSON configuration file that defines the External Access Log
076   * Publisher. The content of the JSON configuration file depends on
077   * the type of external audit event handler. The path to the file is
078   * relative to the server root.
079   *
080   * @return Returns the value of the "config-file" property.
081   */
082  String getConfigFile();
083
084
085
086  /**
087   * Gets 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   * @return Returns the value of the "java-class" property.
093   */
094  String getJavaClass();
095
096
097
098  /**
099   * Gets the "log-control-oids" property.
100   * <p>
101   * Specifies whether control OIDs will be included in operation log
102   * records.
103   *
104   * @return Returns the value of the "log-control-oids" property.
105   */
106  boolean isLogControlOids();
107
108}