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 legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2008 Sun Microsystems, Inc. 025 */ 026package org.opends.server.admin.std.server; 027 028 029 030import org.opends.server.admin.server.ConfigurationChangeListener; 031import org.opends.server.admin.std.meta.ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy; 032import org.opends.server.types.AttributeType; 033import org.opends.server.types.DN; 034 035 036 037/** 038 * A server-side interface for querying External SASL Mechanism 039 * Handler settings. 040 * <p> 041 * The External SASL Mechanism Handler performs all processing related 042 * to SASL EXTERNAL authentication. 043 */ 044public interface ExternalSASLMechanismHandlerCfg extends SASLMechanismHandlerCfg { 045 046 /** 047 * Gets the configuration class associated with this External SASL Mechanism Handler. 048 * 049 * @return Returns the configuration class associated with this External SASL Mechanism Handler. 050 */ 051 Class<? extends ExternalSASLMechanismHandlerCfg> configurationClass(); 052 053 054 055 /** 056 * Register to be notified when this External SASL Mechanism Handler is changed. 057 * 058 * @param listener 059 * The External SASL Mechanism Handler configuration change listener. 060 */ 061 void addExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener); 062 063 064 065 /** 066 * Deregister an existing External SASL Mechanism Handler configuration change listener. 067 * 068 * @param listener 069 * The External SASL Mechanism Handler configuration change listener. 070 */ 071 void removeExternalChangeListener(ConfigurationChangeListener<ExternalSASLMechanismHandlerCfg> listener); 072 073 074 075 /** 076 * Gets the "certificate-attribute" property. 077 * <p> 078 * Specifies the name of the attribute to hold user certificates. 079 * <p> 080 * This property must specify the name of a valid attribute type 081 * defined in the server schema. 082 * 083 * @return Returns the value of the "certificate-attribute" property. 084 */ 085 AttributeType getCertificateAttribute(); 086 087 088 089 /** 090 * Gets the "certificate-mapper" property. 091 * <p> 092 * Specifies the name of the certificate mapper that should be used 093 * to match client certificates to user entries. 094 * 095 * @return Returns the value of the "certificate-mapper" property. 096 */ 097 String getCertificateMapper(); 098 099 100 101 /** 102 * Gets the "certificate-mapper" property as a DN. 103 * <p> 104 * Specifies the name of the certificate mapper that should be used 105 * to match client certificates to user entries. 106 * 107 * @return Returns the DN value of the "certificate-mapper" 108 * property. 109 */ 110 DN getCertificateMapperDN(); 111 112 113 114 /** 115 * Gets the "certificate-validation-policy" property. 116 * <p> 117 * Indicates whether to attempt to validate the peer certificate 118 * against a certificate held in the user's entry. 119 * 120 * @return Returns the value of the "certificate-validation-policy" property. 121 */ 122 CertificateValidationPolicy getCertificateValidationPolicy(); 123 124 125 126 /** 127 * Gets the "java-class" property. 128 * <p> 129 * Specifies the fully-qualified name of the Java class that 130 * provides the SASL mechanism handler implementation. 131 * 132 * @return Returns the value of the "java-class" property. 133 */ 134 String getJavaClass(); 135 136}