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