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 java.util.Collection;
031import java.util.SortedSet;
032import org.opends.server.admin.ManagedObjectDefinition;
033import org.opends.server.admin.PropertyException;
034import org.opends.server.admin.std.server.SubjectDNToUserAttributeCertificateMapperCfg;
035import org.opends.server.types.AttributeType;
036import org.opends.server.types.DN;
037
038
039
040/**
041 * A client-side interface for reading and modifying Subject DN To
042 * User Attribute Certificate Mapper settings.
043 * <p>
044 * The Subject DN To User Attribute Certificate Mapper maps client
045 * certificates to user entries by looking for the certificate subject
046 * DN in a specified attribute of user entries.
047 */
048public interface SubjectDNToUserAttributeCertificateMapperCfgClient extends CertificateMapperCfgClient {
049
050  /**
051   * Get the configuration definition associated with this Subject DN To User Attribute Certificate Mapper.
052   *
053   * @return Returns the configuration definition associated with this Subject DN To User Attribute Certificate Mapper.
054   */
055  ManagedObjectDefinition<? extends SubjectDNToUserAttributeCertificateMapperCfgClient, ? extends SubjectDNToUserAttributeCertificateMapperCfg> definition();
056
057
058
059  /**
060   * Gets the "java-class" property.
061   * <p>
062   * Specifies the fully-qualified name of the Java class that
063   * provides the Subject DN To User Attribute Certificate Mapper
064   * implementation.
065   *
066   * @return Returns the value of the "java-class" property.
067   */
068  String getJavaClass();
069
070
071
072  /**
073   * Sets the "java-class" property.
074   * <p>
075   * Specifies the fully-qualified name of the Java class that
076   * provides the Subject DN To User Attribute Certificate Mapper
077   * implementation.
078   *
079   * @param value The value of the "java-class" property.
080   * @throws PropertyException
081   *           If the new value is invalid.
082   */
083  void setJavaClass(String value) throws PropertyException;
084
085
086
087  /**
088   * Gets the "subject-attribute" property.
089   * <p>
090   * Specifies the name or OID of the attribute whose value should
091   * exactly match the certificate subject DN.
092   *
093   * @return Returns the value of the "subject-attribute" property.
094   */
095  AttributeType getSubjectAttribute();
096
097
098
099  /**
100   * Sets the "subject-attribute" property.
101   * <p>
102   * Specifies the name or OID of the attribute whose value should
103   * exactly match the certificate subject DN.
104   *
105   * @param value The value of the "subject-attribute" property.
106   * @throws PropertyException
107   *           If the new value is invalid.
108   */
109  void setSubjectAttribute(AttributeType value) throws PropertyException;
110
111
112
113  /**
114   * Gets the "user-base-dn" property.
115   * <p>
116   * Specifies the base DNs that should be used when performing
117   * searches to map the client certificate to a user entry.
118   *
119   * @return Returns the values of the "user-base-dn" property.
120   */
121  SortedSet<DN> getUserBaseDN();
122
123
124
125  /**
126   * Sets the "user-base-dn" property.
127   * <p>
128   * Specifies the base DNs that should be used when performing
129   * searches to map the client certificate to a user entry.
130   *
131   * @param values The values of the "user-base-dn" property.
132   * @throws PropertyException
133   *           If one or more of the new values are invalid.
134   */
135  void setUserBaseDN(Collection<DN> values) throws PropertyException;
136
137}