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    package org.apache.directory.server.ldap.handlers.bind.plain;
021    
022    
023    import org.apache.directory.server.core.CoreSession;
024    import org.apache.directory.server.ldap.LdapSession;
025    import org.apache.directory.server.ldap.handlers.bind.AbstractMechanismHandler;
026    import org.apache.directory.server.ldap.handlers.bind.SaslConstants;
027    import org.apache.directory.shared.ldap.message.InternalBindRequest;
028    
029    import javax.security.sasl.SaslServer;
030    
031    
032    /**
033     * A handler for the PLAIN Sasl mechanism. 
034     *
035     * @org.apache.xbean.XBean
036     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
037     * @version $Rev$, $Date$
038     */
039    public class PlainMechanismHandler extends AbstractMechanismHandler
040    {
041        
042        /**
043         * {@inheritDoc}
044         */
045        public SaslServer handleMechanism( LdapSession ldapSession, InternalBindRequest bindRequest ) throws Exception
046        {
047            SaslServer ss = ( SaslServer ) ldapSession.getSaslProperty( SaslConstants.SASL_SERVER );
048            
049            if ( ss == null )
050            {
051                CoreSession adminSession = ldapSession.getLdapServer().getDirectoryService().getAdminSession();
052    
053                ss = new PlainSaslServer( ldapSession, adminSession, bindRequest );
054                ldapSession.putSaslProperty( SaslConstants.SASL_SERVER, ss );
055            }
056    
057            return ss;
058        }
059    
060    
061        /**
062         * {@inheritDoc}
063         */
064        public void init( LdapSession ldapSession )
065        {
066            // Do nothing
067        }
068    
069        
070        /**
071         * Remove the SaslServer and Mechanism property.
072         * 
073         * @param ldapSession the Ldapsession instance
074         */
075        public void cleanup( LdapSession ldapSession )
076        {
077            ldapSession.clearSaslProperties();
078        }
079    }