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.server;
028    
029    
030    
031    import org.opends.server.admin.server.ConfigurationChangeListener;
032    
033    
034    
035    /**
036     * A server-side interface for querying Access Log Publisher settings.
037     * <p>
038     * Access Log Publishers are responsible for distributing access log
039     * messages from the access logger to a destination.
040     */
041    public interface AccessLogPublisherCfg extends LogPublisherCfg {
042    
043      /**
044       * Gets the configuration class associated with this Access Log Publisher.
045       *
046       * @return Returns the configuration class associated with this Access Log Publisher.
047       */
048      Class<? extends AccessLogPublisherCfg> configurationClass();
049    
050    
051    
052      /**
053       * Register to be notified when this Access Log Publisher is changed.
054       *
055       * @param listener
056       *          The Access Log Publisher configuration change listener.
057       */
058      void addAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener);
059    
060    
061    
062      /**
063       * Deregister an existing Access Log Publisher configuration change listener.
064       *
065       * @param listener
066       *          The Access Log Publisher configuration change listener.
067       */
068      void removeAccessChangeListener(ConfigurationChangeListener<AccessLogPublisherCfg> listener);
069    
070    
071    
072      /**
073       * Gets the "java-class" property.
074       * <p>
075       * The fully-qualified name of the Java class that provides the
076       * Access Log Publisher implementation.
077       *
078       * @return Returns the value of the "java-class" property.
079       */
080      String getJavaClass();
081    
082    
083    
084      /**
085       * Gets the "suppress-internal-operations" property.
086       * <p>
087       * Indicates whether internal operations (for example, operations
088       * that are initiated by plugins) should be logged along with the
089       * operations that are requested by users.
090       *
091       * @return Returns the value of the "suppress-internal-operations" property.
092       */
093      boolean isSuppressInternalOperations();
094    
095    
096    
097      /**
098       * Gets the "suppress-synchronization-operations" property.
099       * <p>
100       * Indicates whether access messages that are generated by
101       * synchronization operations should be suppressed.
102       *
103       * @return Returns the value of the "suppress-synchronization-operations" property.
104       */
105      boolean isSuppressSynchronizationOperations();
106    
107    }