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.forgerock.opendj.server.config.server;
017
018
019
020import org.forgerock.opendj.config.Configuration;
021import org.forgerock.opendj.config.server.ConfigurationChangeListener;
022
023
024
025/**
026 * A server-side interface for querying HTTP Authorization Mechanism
027 * settings.
028 * <p>
029 * The HTTP Authorization Mechanism is used to define HTTP
030 * authorization mechanism.
031 */
032public interface HTTPAuthorizationMechanismCfg extends Configuration {
033
034  /**
035   * Gets the configuration class associated with this HTTP Authorization Mechanism.
036   *
037   * @return Returns the configuration class associated with this HTTP Authorization Mechanism.
038   */
039  Class<? extends HTTPAuthorizationMechanismCfg> configurationClass();
040
041
042
043  /**
044   * Register to be notified when this HTTP Authorization Mechanism is changed.
045   *
046   * @param listener
047   *          The HTTP Authorization Mechanism configuration change listener.
048   */
049  void addChangeListener(ConfigurationChangeListener<HTTPAuthorizationMechanismCfg> listener);
050
051
052
053  /**
054   * Deregister an existing HTTP Authorization Mechanism configuration change listener.
055   *
056   * @param listener
057   *          The HTTP Authorization Mechanism configuration change listener.
058   */
059  void removeChangeListener(ConfigurationChangeListener<HTTPAuthorizationMechanismCfg> listener);
060
061
062
063  /**
064   * Gets the "enabled" property.
065   * <p>
066   * Indicates whether the HTTP Authorization Mechanism is enabled.
067   *
068   * @return Returns the value of the "enabled" property.
069   */
070  boolean isEnabled();
071
072
073
074  /**
075   * Gets the "java-class" property.
076   * <p>
077   * Specifies the fully-qualified name of the Java class that
078   * provides the HTTP Authorization Mechanism implementation.
079   *
080   * @return Returns the value of the "java-class" property.
081   */
082  String getJavaClass();
083
084}