001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    
021    package org.apache.directory.server.ldap.handlers.bind;
022    
023    /**
024     * SASL Constants used to store informations releated to the Challenge/response
025     * exchange during the SASL negociation.
026     *
027     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
028     * @version $Rev$, $Date$
029     */
030    public class SaslConstants
031    {
032        /**
033         * A key constant for storing the SASL Server in the session.
034         */
035        public static final String SASL_SERVER = "saslServer";
036        
037        /**
038         * A key constant for storing the SASL host in the session
039         */
040        public static final String SASL_HOST = "host";
041        
042        /**
043         * A key constant used when creating a SaslServer
044         */
045        public static final String LDAP_PROTOCOL = "ldap";
046        
047        
048        /**
049         * A key constant for storing the place where we are to search for user's pasword
050         */
051        public static final String SASL_USER_BASE_DN = "userBaseDn";
052        
053        
054        /**
055         * A key constant for storing the current mechanism
056         */
057        public static final String SASL_MECH = "saslMech";
058        
059        
060        /**
061         * A key constant for storing the authenticated user
062         */
063        public static final String SASL_AUTHENT_USER = "saslAuthentUser";
064        
065        
066        /**
067         * A key constant for storing the evaluated credentials
068         */
069        public static final String SASL_CREDS = "saslCreds";
070    
071    
072        /**
073         * A key constant for storing the Quality Of Protection
074         */
075        public static final String SASL_QOP = "saslQop";
076        
077        
078        /**
079         * A key constant for storing the realm
080         */
081        public static final String SASL_REALM = "saslRealm";
082        
083        
084        /**
085         * A key constant representing the SASL properties 
086         */
087        public static final String SASL_PROPS = "saslProps";
088        
089        
090        /**
091         * A key constant representing the SASL mechanism handler
092         */
093        public static final String SASL_MECH_HANDLER = "saslmechHandler";
094        
095        
096        /**
097         * A key constant representing the SASL IoFilter 
098         */
099        public static final String SASL_FILTER = "SASL_FILTER";
100    }