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