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    package org.apache.james.protocols.smtp.hook;
020    
021    import org.apache.james.protocols.smtp.SMTPSession;
022    
023    /**
024     * Implement this interfaces to hook in the AUTH Command
025     */
026    public interface AuthHook extends Hook{
027    
028        /**
029         * Return the HookResult after run the hook
030         * 
031         * @param session the SMTPSession
032         * @param username the username
033         * @param password the password
034         * @return HockResult
035         */
036        HookResult doAuth(SMTPSession session, String username, String password);
037    }