001    /*
002     * Copyright 2010 the original author or authors.
003     * 
004     *  Licensed under the Apache License, Version 2.0 (the "License");
005     *  you may not use this file except in compliance with the License.
006     *  You may obtain a copy of the License at
007     *
008     *      http://www.apache.org/licenses/LICENSE-2.0
009     *
010     *  Unless required by applicable law or agreed to in writing, software
011     *  distributed under the License is distributed on an "AS IS" BASIS,
012     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     *  See the License for the specific language governing permissions and
014     *  limitations under the License.
015     */
016    package com.hs.mail.imap.processor;
017    
018    import org.jboss.netty.channel.Channel;
019    
020    import com.hs.mail.imap.ImapSession;
021    import com.hs.mail.imap.message.request.ImapRequest;
022    
023    /**
024     * <p>
025     * IMAP command processor.
026     * </p>
027     * <p>
028     * <strong>Note:</strong> this is a transitional API and is liable to change.
029     * </p>
030     * 
031     * @author Won Chul Doh
032     * @since Jan 31, 2010
033     */
034    public interface ImapProcessor {
035    
036            /**
037             * Performs processing of the command. If this process does not understand
038             * the given message or failed to process then it must return an appropriate
039             * message as per the specification.
040             * 
041             * @param session
042             * @param message
043             * @param channel
044             */
045            public void process(ImapSession session, ImapRequest message,
046                            Channel channel);
047    
048    }