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 org.forgerock.opendj.config.server.ConfigurationChangeListener; 021import org.forgerock.opendj.ldap.DN; 022 023 024 025/** 026 * A server-side interface for querying HTTP Basic Authorization 027 * Mechanism settings. 028 * <p> 029 * The HTTP Basic Authorization Mechanism authenticates the end-user 030 * using credentials extracted from the HTTP Basic 'Authorization' 031 * header. 032 */ 033public interface HTTPBasicAuthorizationMechanismCfg extends HTTPAuthorizationMechanismCfg { 034 035 /** 036 * Gets the configuration class associated with this HTTP Basic Authorization Mechanism. 037 * 038 * @return Returns the configuration class associated with this HTTP Basic Authorization Mechanism. 039 */ 040 Class<? extends HTTPBasicAuthorizationMechanismCfg> configurationClass(); 041 042 043 044 /** 045 * Register to be notified when this HTTP Basic Authorization Mechanism is changed. 046 * 047 * @param listener 048 * The HTTP Basic Authorization Mechanism configuration change listener. 049 */ 050 void addHTTPBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPBasicAuthorizationMechanismCfg> listener); 051 052 053 054 /** 055 * Deregister an existing HTTP Basic Authorization Mechanism configuration change listener. 056 * 057 * @param listener 058 * The HTTP Basic Authorization Mechanism configuration change listener. 059 */ 060 void removeHTTPBasicAuthorizationMechanismChangeListener(ConfigurationChangeListener<HTTPBasicAuthorizationMechanismCfg> listener); 061 062 063 064 /** 065 * Gets the "alt-authentication-enabled" property. 066 * <p> 067 * Specifies whether user credentials may be provided using 068 * alternative headers to the standard 'Authorize' header. 069 * 070 * @return Returns the value of the "alt-authentication-enabled" property. 071 */ 072 boolean isAltAuthenticationEnabled(); 073 074 075 076 /** 077 * Gets the "alt-password-header" property. 078 * <p> 079 * Alternate HTTP headers to get the user's password from. 080 * 081 * @return Returns the value of the "alt-password-header" property. 082 */ 083 String getAltPasswordHeader(); 084 085 086 087 /** 088 * Gets the "alt-username-header" property. 089 * <p> 090 * Alternate HTTP headers to get the user's name from. 091 * 092 * @return Returns the value of the "alt-username-header" property. 093 */ 094 String getAltUsernameHeader(); 095 096 097 098 /** 099 * Gets the "identity-mapper" property. 100 * <p> 101 * > Specifies the name of the identity mapper used to get the 102 * user's entry corresponding to the user-id provided in the HTTP 103 * authentication header. 104 * 105 * @return Returns the value of the "identity-mapper" property. 106 */ 107 String getIdentityMapper(); 108 109 110 111 /** 112 * Gets the "identity-mapper" property as a DN. 113 * <p> 114 * > Specifies the name of the identity mapper used to get the 115 * user's entry corresponding to the user-id provided in the HTTP 116 * authentication header. 117 * 118 * @return Returns the DN value of the "identity-mapper" property. 119 */ 120 DN getIdentityMapperDN(); 121 122 123 124 /** 125 * Gets the "java-class" property. 126 * <p> 127 * Specifies the fully-qualified name of the Java class that 128 * provides the HTTP Basic Authorization Mechanism implementation. 129 * 130 * @return Returns the value of the "java-class" property. 131 */ 132 String getJavaClass(); 133 134}