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