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