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.client; 027 028 029 030import org.opends.server.admin.ManagedObjectDefinition; 031import org.opends.server.admin.PropertyException; 032import org.opends.server.admin.std.meta.ExternalSASLMechanismHandlerCfgDefn.CertificateValidationPolicy; 033import org.opends.server.admin.std.server.ExternalSASLMechanismHandlerCfg; 034import org.opends.server.types.AttributeType; 035 036 037 038/** 039 * A client-side interface for reading and modifying External SASL 040 * Mechanism Handler settings. 041 * <p> 042 * The External SASL Mechanism Handler performs all processing related 043 * to SASL EXTERNAL authentication. 044 */ 045public interface ExternalSASLMechanismHandlerCfgClient extends SASLMechanismHandlerCfgClient { 046 047 /** 048 * Get the configuration definition associated with this External SASL Mechanism Handler. 049 * 050 * @return Returns the configuration definition associated with this External SASL Mechanism Handler. 051 */ 052 ManagedObjectDefinition<? extends ExternalSASLMechanismHandlerCfgClient, ? extends ExternalSASLMechanismHandlerCfg> definition(); 053 054 055 056 /** 057 * Gets the "certificate-attribute" property. 058 * <p> 059 * Specifies the name of the attribute to hold user certificates. 060 * <p> 061 * This property must specify the name of a valid attribute type 062 * defined in the server schema. 063 * 064 * @return Returns the value of the "certificate-attribute" property. 065 */ 066 AttributeType getCertificateAttribute(); 067 068 069 070 /** 071 * Sets the "certificate-attribute" property. 072 * <p> 073 * Specifies the name of the attribute to hold user certificates. 074 * <p> 075 * This property must specify the name of a valid attribute type 076 * defined in the server schema. 077 * 078 * @param value The value of the "certificate-attribute" property. 079 * @throws PropertyException 080 * If the new value is invalid. 081 */ 082 void setCertificateAttribute(AttributeType value) throws PropertyException; 083 084 085 086 /** 087 * Gets the "certificate-mapper" property. 088 * <p> 089 * Specifies the name of the certificate mapper that should be used 090 * to match client certificates to user entries. 091 * 092 * @return Returns the value of the "certificate-mapper" property. 093 */ 094 String getCertificateMapper(); 095 096 097 098 /** 099 * Sets the "certificate-mapper" property. 100 * <p> 101 * Specifies the name of the certificate mapper that should be used 102 * to match client certificates to user entries. 103 * 104 * @param value The value of the "certificate-mapper" property. 105 * @throws PropertyException 106 * If the new value is invalid. 107 */ 108 void setCertificateMapper(String value) throws PropertyException; 109 110 111 112 /** 113 * Gets the "certificate-validation-policy" property. 114 * <p> 115 * Indicates whether to attempt to validate the peer certificate 116 * against a certificate held in the user's entry. 117 * 118 * @return Returns the value of the "certificate-validation-policy" property. 119 */ 120 CertificateValidationPolicy getCertificateValidationPolicy(); 121 122 123 124 /** 125 * Sets the "certificate-validation-policy" property. 126 * <p> 127 * Indicates whether to attempt to validate the peer certificate 128 * against a certificate held in the user's entry. 129 * 130 * @param value The value of the "certificate-validation-policy" property. 131 * @throws PropertyException 132 * If the new value is invalid. 133 */ 134 void setCertificateValidationPolicy(CertificateValidationPolicy value) throws PropertyException; 135 136 137 138 /** 139 * Gets the "java-class" property. 140 * <p> 141 * Specifies the fully-qualified name of the Java class that 142 * provides the SASL mechanism handler implementation. 143 * 144 * @return Returns the value of the "java-class" property. 145 */ 146 String getJavaClass(); 147 148 149 150 /** 151 * Sets the "java-class" property. 152 * <p> 153 * Specifies the fully-qualified name of the Java class that 154 * provides the SASL mechanism handler implementation. 155 * 156 * @param value The value of the "java-class" property. 157 * @throws PropertyException 158 * If the new value is invalid. 159 */ 160 void setJavaClass(String value) throws PropertyException; 161 162}