session.java

Java Mail Server JAVA编写的邮件服务器

/****************************************************************
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.     *
 *                                                              *
 * Copyright 2008 Jun Li(SiChuan University, the School of      *
 * Software Engineering). All rights reserved.                  *
 *                                                              *
 * Licensed to the JMS under one  or more contributor license   *
 * agreements.  See the LICENCE file  distributed with this     *
 * work for additional information regarding copyright          *
 * ownership.  The JMS licenses this file  you may not use this *
 * file except in compliance  with the License.                 *
 *                                                              *
 * 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.jpxx.mail.Service;

import java.io.IOException;
import java.net.Socket;
import java.util.HashMap;


/**
 * This is an interface to define the communication of server and client.
 * 
 * @author Jun Li
 * @version $Revision: 0.0.1 $, $Date: 2008/04/23 08:12:00 $
 */
public interface Session {
    
    /**
     * Get client socket.
     * 
     * @return client socket
     */
    public Socket getClinetSocket();
    
    /**
     * Set client socket
     * 
     * @param socket
     */
    public void setClientSocket(Socket socket);
    
    /**
     * Read a line from the request of client 
     * @return a line of String.(Command line)
     * @throws java.io.IOException
     */
    public String readCommandLine() throws IOException ;
    
    /**
     * Read an origin line
     * @return a line of data string
     * @throws java.io.IOException
     * @since JMS 0.0.3
     */
    public String readLine() throws IOException ;
    
    /**
     * Server response
     * 
     * @param response
     */
    public void writeResponse(String response);
    
    /**
     * Get an object of a line string
     * 
     * @param strLine
     * @return an object of CommandLine
     */
    public CommandLine getCommandLine(String strLine);
    
    /**
     * Get last read (line)
     * 
     * @return an object of CommandLine
     */
    public CommandLine getCommandLine();
        
    /**
     * Store Operation to a hash map
     * Get the operation
     * @return hash map
     */
    public HashMap getOperation();
        
    /**
     * Add operation to map
     * @param name
     * @param value
     */
    public void addOperation(String name, Object value);
    
    /**
     * Clear the operation int map 
     */
    public void clear();
    
    /**
     * Get Last Action value(Integer)
     * @return last action
     */
    public int getLastAction();
    
    /**
     * Set Last command value(Integer)
     * @param lastAction the last command number
     */
    
    public void setLastAction(int lastAction);
    
    /**
     * Close current session. Client is quit. Release the resource.
     */
    public void close();    
}