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