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