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
010     * trunk/opends/resource/legal-notices/OpenDS.LICENSE
011     * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
012     * See the License for the specific language governing permissions
013     * and limitations under the License.
014     *
015     * When distributing Covered Code, include this CDDL HEADER in each
016     * file and include the License file at
017     * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
018     * add the following below this CDDL HEADER, with the fields enclosed
019     * by brackets "[]" replaced with your own identifying information:
020     *      Portions Copyright [yyyy] [name of copyright owner]
021     *
022     * CDDL HEADER END
023     *
024     *
025     *      Copyright 2008 Sun Microsystems, Inc.
026     */
027    package org.opends.server.admin.std.client;
028    
029    
030    
031    import org.opends.server.admin.ConfigurationClient;
032    import org.opends.server.admin.IllegalPropertyValueException;
033    import org.opends.server.admin.ManagedObjectDefinition;
034    import org.opends.server.admin.std.server.CertificateMapperCfg;
035    
036    
037    
038    /**
039     * A client-side interface for reading and modifying Certificate
040     * Mapper settings.
041     * <p>
042     * Certificate Mappers are responsible for establishing a mapping
043     * between a client certificate and the entry for the user that
044     * corresponds to that certificate.
045     */
046    public interface CertificateMapperCfgClient extends ConfigurationClient {
047    
048      /**
049       * Get the configuration definition associated with this Certificate Mapper.
050       *
051       * @return Returns the configuration definition associated with this Certificate Mapper.
052       */
053      ManagedObjectDefinition<? extends CertificateMapperCfgClient, ? extends CertificateMapperCfg> definition();
054    
055    
056    
057      /**
058       * Gets the "enabled" property.
059       * <p>
060       * Indicates whether the Certificate Mapper is enabled.
061       *
062       * @return Returns the value of the "enabled" property.
063       */
064      Boolean isEnabled();
065    
066    
067    
068      /**
069       * Sets the "enabled" property.
070       * <p>
071       * Indicates whether the Certificate Mapper is enabled.
072       *
073       * @param value The value of the "enabled" property.
074       * @throws IllegalPropertyValueException
075       *           If the new value is invalid.
076       */
077      void setEnabled(boolean value) throws IllegalPropertyValueException;
078    
079    
080    
081      /**
082       * Gets the "java-class" property.
083       * <p>
084       * Specifies the fully-qualified name of the Java class that
085       * provides the Certificate Mapper implementation.
086       *
087       * @return Returns the value of the "java-class" property.
088       */
089      String getJavaClass();
090    
091    
092    
093      /**
094       * Sets the "java-class" property.
095       * <p>
096       * Specifies the fully-qualified name of the Java class that
097       * provides the Certificate Mapper implementation.
098       *
099       * @param value The value of the "java-class" property.
100       * @throws IllegalPropertyValueException
101       *           If the new value is invalid.
102       */
103      void setJavaClass(String value) throws IllegalPropertyValueException;
104    
105    }