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.opends.server.admin.std.server;
027
028
029
030import org.opends.server.admin.Configuration;
031import org.opends.server.admin.server.ConfigurationChangeListener;
032
033
034
035/**
036 * A server-side interface for querying Access Control Handler
037 * settings.
038 * <p>
039 * Access Control Handlers manage the application-wide access control.
040 * The OpenDJ access control handler is defined through an extensible
041 * interface, so that alternate implementations can be created. Only
042 * one access control handler may be active in the server at any given
043 * time.
044 */
045public interface AccessControlHandlerCfg extends Configuration {
046
047  /**
048   * Gets the configuration class associated with this Access Control Handler.
049   *
050   * @return Returns the configuration class associated with this Access Control Handler.
051   */
052  Class<? extends AccessControlHandlerCfg> configurationClass();
053
054
055
056  /**
057   * Register to be notified when this Access Control Handler is changed.
058   *
059   * @param listener
060   *          The Access Control Handler configuration change listener.
061   */
062  void addChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener);
063
064
065
066  /**
067   * Deregister an existing Access Control Handler configuration change listener.
068   *
069   * @param listener
070   *          The Access Control Handler configuration change listener.
071   */
072  void removeChangeListener(ConfigurationChangeListener<AccessControlHandlerCfg> listener);
073
074
075
076  /**
077   * Gets the "enabled" property.
078   * <p>
079   * Indicates whether the Access Control Handler is enabled. If set
080   * to FALSE, then no access control is enforced, and any client
081   * (including unauthenticated or anonymous clients) could be allowed
082   * to perform any operation if not subject to other restrictions,
083   * such as those enforced by the privilege subsystem.
084   *
085   * @return Returns the value of the "enabled" property.
086   */
087  boolean isEnabled();
088
089
090
091  /**
092   * Gets the "java-class" property.
093   * <p>
094   * Specifies the fully-qualified name of the Java class that
095   * provides the Access Control Handler implementation.
096   *
097   * @return Returns the value of the "java-class" property.
098   */
099  String getJavaClass();
100
101}