/*
 *  Licensed to the Apache Software Foundation (ASF) under one
 *  or more contributor license agreements.  See the NOTICE file
 *  distributed with this work for additional information
 *  regarding copyright ownership.  The ASF licenses this file
 *  to you under the Apache License, Version 2.0 (the
 *  "License"); you may not use this file except in compliance
 *  with the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing,
 *  software distributed under the License is distributed on an
 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 *  KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations
 *  under the License.
 *
 */
package org.apache.directory.server.ldap.handlers.sasl;


import javax.security.sasl.SaslServer;

import org.apache.directory.api.ldap.model.message.BindRequest;
import org.apache.directory.server.ldap.LdapSession;


/**
 * An interface for retrieving a {@link SaslServer} for a session.
 * 
 * @see javax.security.sasl.SaslServer
 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
 */
public interface MechanismHandler
{
    /**
     * Implementors will use the session and message to determine what kind of
     * {@link SaslServer} to create and what initialization parameters it will require.
     *
     * @param session The LdapSession in use
     * @param bindRequest The BindRequest
     * @return The {@link SaslServer} to use for the duration of the bound session.
     * @throws Exception If we can't find the SASL Mechanism
     */
    SaslServer handleMechanism( LdapSession session, BindRequest bindRequest ) throws Exception;


    /**
     * Initialize the saslProperties with some mechanism's specific data
     *
     * @param ldapSession the Ldapsession instance
     */
    void init( LdapSession ldapSession );


    /**
     * Clean the Sasl properties when the use has been authenticated
     *
     * @param ldapSession the Ldapsession instance
     */
    void cleanup( LdapSession ldapSession );
}
