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