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