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 java.util.SortedSet;
032    import org.opends.server.admin.server.ConfigurationChangeListener;
033    import org.opends.server.authorization.dseecompat.Aci;
034    
035    
036    
037    /**
038     * A server-side interface for querying Dsee Compat Access Control
039     * Handler settings.
040     * <p>
041     * The Dsee Compat Access Control Handler provides an implementation
042     * that uses syntax compatible with the Sun Java System Directory
043     * Server Enterprise Edition access control handlers.
044     */
045    public interface DseeCompatAccessControlHandlerCfg extends AccessControlHandlerCfg {
046    
047      /**
048       * Gets the configuration class associated with this Dsee Compat Access Control Handler.
049       *
050       * @return Returns the configuration class associated with this Dsee Compat Access Control Handler.
051       */
052      Class<? extends DseeCompatAccessControlHandlerCfg> configurationClass();
053    
054    
055    
056      /**
057       * Register to be notified when this Dsee Compat Access Control Handler is changed.
058       *
059       * @param listener
060       *          The Dsee Compat Access Control Handler configuration change listener.
061       */
062      void addDseeCompatChangeListener(ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener);
063    
064    
065    
066      /**
067       * Deregister an existing Dsee Compat Access Control Handler configuration change listener.
068       *
069       * @param listener
070       *          The Dsee Compat Access Control Handler configuration change listener.
071       */
072      void removeDseeCompatChangeListener(ConfigurationChangeListener<DseeCompatAccessControlHandlerCfg> listener);
073    
074    
075    
076      /**
077       * Gets the "global-aci" property.
078       * <p>
079       * Defines global access control rules.
080       * <p>
081       * Global access control rules apply to all entries anywhere in the
082       * data managed by the Directory Server. The global access control
083       * rules may be overridden by more specific access control rules
084       * placed in the data.
085       *
086       * @return Returns an unmodifiable set containing the values of the "global-aci" property.
087       */
088      SortedSet<Aci> getGlobalACI();
089    
090    
091    
092      /**
093       * Gets the "java-class" property.
094       * <p>
095       * Specifies the fully-qualified name of the Java class that
096       * provides the Dsee Compat Access Control Handler implementation.
097       *
098       * @return Returns the value of the "java-class" property.
099       */
100      String getJavaClass();
101    
102    }