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 Certificate Mapper settings.
037 * <p>
038 * Certificate Mappers are responsible for establishing a mapping
039 * between a client certificate and the entry for the user that
040 * corresponds to that certificate.
041 */
042public interface CertificateMapperCfg extends Configuration {
043
044  /**
045   * Gets the configuration class associated with this Certificate Mapper.
046   *
047   * @return Returns the configuration class associated with this Certificate Mapper.
048   */
049  Class<? extends CertificateMapperCfg> configurationClass();
050
051
052
053  /**
054   * Register to be notified when this Certificate Mapper is changed.
055   *
056   * @param listener
057   *          The Certificate Mapper configuration change listener.
058   */
059  void addChangeListener(ConfigurationChangeListener<CertificateMapperCfg> listener);
060
061
062
063  /**
064   * Deregister an existing Certificate Mapper configuration change listener.
065   *
066   * @param listener
067   *          The Certificate Mapper configuration change listener.
068   */
069  void removeChangeListener(ConfigurationChangeListener<CertificateMapperCfg> listener);
070
071
072
073  /**
074   * Gets the "enabled" property.
075   * <p>
076   * Indicates whether the Certificate Mapper is enabled.
077   *
078   * @return Returns the value of the "enabled" property.
079   */
080  boolean isEnabled();
081
082
083
084  /**
085   * Gets the "java-class" property.
086   * <p>
087   * Specifies the fully-qualified name of the Java class that
088   * provides the Certificate Mapper implementation.
089   *
090   * @return Returns the value of the "java-class" property.
091   */
092  String getJavaClass();
093
094}