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 org.opends.server.admin.server.ConfigurationChangeListener; 032 import org.opends.server.admin.std.meta.ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy; 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 External SASL Mechanism 040 * Handler settings. 041 * <p> 042 * The External SASL Mechanism Handler performs all processing related 043 * to SASL EXTERNAL authentication. 044 */ 045 public interface ExternalSASLMechanismHandlerCfg extends SASLMechanismHandlerCfg { 046 047 /** 048 * Gets the configuration class associated with this External SASL Mechanism Handler. 049 * 050 * @return Returns the configuration class associated with this External SASL Mechanism Handler. 051 */ 052 Class<? extends ExternalSASLMechanismHandlerCfg> configurationClass(); 053 054 055 056 /** 057 * Register to be notified when this External SASL Mechanism Handler is changed. 058 * 059 * @param listener 060 * The External SASL Mechanism Handler configuration change listener. 061 */ 062 void addExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener); 063 064 065 066 /** 067 * Deregister an existing External SASL Mechanism Handler configuration change listener. 068 * 069 * @param listener 070 * The External SASL Mechanism Handler configuration change listener. 071 */ 072 void removeExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener); 073 074 075 076 /** 077 * Gets the "certificate-attribute" property. 078 * <p> 079 * Specifies the name of the attribute to hold user certificates. 080 * <p> 081 * This property must specify the name of a valid attribute type 082 * defined in the server schema. 083 * 084 * @return Returns the value of the "certificate-attribute" property. 085 */ 086 AttributeType getCertificateAttribute(); 087 088 089 090 /** 091 * Gets the "certificate-mapper" property. 092 * <p> 093 * Specifies the name of the certificate mapper that should be used 094 * to match client certificates to user entries. 095 * 096 * @return Returns the value of the "certificate-mapper" property. 097 */ 098 String getCertificateMapper(); 099 100 101 102 /** 103 * Gets the "certificate-mapper" property as a DN. 104 * <p> 105 * Specifies the name of the certificate mapper that should be used 106 * to match client certificates to user entries. 107 * 108 * @return Returns the DN value of the "certificate-mapper" 109 * property. 110 */ 111 DN getCertificateMapperDN(); 112 113 114 115 /** 116 * Gets the "certificate-validation-policy" property. 117 * <p> 118 * Indicates whether to attempt to validate the peer certificate 119 * against a certificate held in the user's entry. 120 * 121 * @return Returns the value of the "certificate-validation-policy" property. 122 */ 123 CertificateValidationPolicy getCertificateValidationPolicy(); 124 125 126 127 /** 128 * Gets the "java-class" property. 129 * <p> 130 * Specifies the fully-qualified name of the Java class that 131 * provides the SASL mechanism handler implementation. 132 * 133 * @return Returns the value of the "java-class" property. 134 */ 135 String getJavaClass(); 136 137 }