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.client;
027
028
029
030import org.opends.server.admin.ConfigurationClient;
031import org.opends.server.admin.ManagedObjectDefinition;
032import org.opends.server.admin.PropertyException;
033import org.opends.server.admin.std.server.CertificateMapperCfg;
034
035
036
037/**
038 * A client-side interface for reading and modifying Certificate
039 * Mapper settings.
040 * <p>
041 * Certificate Mappers are responsible for establishing a mapping
042 * between a client certificate and the entry for the user that
043 * corresponds to that certificate.
044 */
045public interface CertificateMapperCfgClient extends ConfigurationClient {
046
047  /**
048   * Get the configuration definition associated with this Certificate Mapper.
049   *
050   * @return Returns the configuration definition associated with this Certificate Mapper.
051   */
052  ManagedObjectDefinition<? extends CertificateMapperCfgClient, ? extends CertificateMapperCfg> definition();
053
054
055
056  /**
057   * Gets the "enabled" property.
058   * <p>
059   * Indicates whether the Certificate Mapper is enabled.
060   *
061   * @return Returns the value of the "enabled" property.
062   */
063  Boolean isEnabled();
064
065
066
067  /**
068   * Sets the "enabled" property.
069   * <p>
070   * Indicates whether the Certificate Mapper is enabled.
071   *
072   * @param value The value of the "enabled" property.
073   * @throws PropertyException
074   *           If the new value is invalid.
075   */
076  void setEnabled(boolean value) throws PropertyException;
077
078
079
080  /**
081   * Gets the "java-class" property.
082   * <p>
083   * Specifies the fully-qualified name of the Java class that
084   * provides the Certificate Mapper implementation.
085   *
086   * @return Returns the value of the "java-class" property.
087   */
088  String getJavaClass();
089
090
091
092  /**
093   * Sets the "java-class" property.
094   * <p>
095   * Specifies the fully-qualified name of the Java class that
096   * provides the Certificate Mapper implementation.
097   *
098   * @param value The value of the "java-class" property.
099   * @throws PropertyException
100   *           If the new value is invalid.
101   */
102  void setJavaClass(String value) throws PropertyException;
103
104}