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.server; 017 018 019 020import java.util.SortedSet; 021import org.forgerock.opendj.config.server.ConfigurationChangeListener; 022import org.forgerock.opendj.ldap.DN; 023import org.forgerock.opendj.ldap.schema.AttributeType; 024 025 026 027/** 028 * A server-side interface for querying Subject DN To User Attribute 029 * Certificate Mapper settings. 030 * <p> 031 * The Subject DN To User Attribute Certificate Mapper maps client 032 * certificates to user entries by looking for the certificate subject 033 * DN in a specified attribute of user entries. 034 */ 035public interface SubjectDNToUserAttributeCertificateMapperCfg extends CertificateMapperCfg { 036 037 /** 038 * Gets the configuration class associated with this Subject DN To User Attribute Certificate Mapper. 039 * 040 * @return Returns the configuration class associated with this Subject DN To User Attribute Certificate Mapper. 041 */ 042 Class<? extends SubjectDNToUserAttributeCertificateMapperCfg> configurationClass(); 043 044 045 046 /** 047 * Register to be notified when this Subject DN To User Attribute Certificate Mapper is changed. 048 * 049 * @param listener 050 * The Subject DN To User Attribute Certificate Mapper configuration change listener. 051 */ 052 void addSubjectDNToUserAttributeChangeListener(ConfigurationChangeListener<SubjectDNToUserAttributeCertificateMapperCfg> listener); 053 054 055 056 /** 057 * Deregister an existing Subject DN To User Attribute Certificate Mapper configuration change listener. 058 * 059 * @param listener 060 * The Subject DN To User Attribute Certificate Mapper configuration change listener. 061 */ 062 void removeSubjectDNToUserAttributeChangeListener(ConfigurationChangeListener<SubjectDNToUserAttributeCertificateMapperCfg> listener); 063 064 065 066 /** 067 * Gets the "java-class" property. 068 * <p> 069 * Specifies the fully-qualified name of the Java class that 070 * provides the Subject DN To User Attribute Certificate Mapper 071 * implementation. 072 * 073 * @return Returns the value of the "java-class" property. 074 */ 075 String getJavaClass(); 076 077 078 079 /** 080 * Gets the "subject-attribute" property. 081 * <p> 082 * Specifies the name or OID of the attribute whose value should 083 * exactly match the certificate subject DN. 084 * 085 * @return Returns the value of the "subject-attribute" property. 086 */ 087 AttributeType getSubjectAttribute(); 088 089 090 091 /** 092 * Gets the "user-base-dn" property. 093 * <p> 094 * Specifies the base DNs that should be used when performing 095 * searches to map the client certificate to a user entry. 096 * 097 * @return Returns an unmodifiable set containing the values of the "user-base-dn" property. 098 */ 099 SortedSet<DN> getUserBaseDN(); 100 101}