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.james.mpt.api;
021
022/**
023 * A connection to the host.
024 */
025public interface Session {
026    
027    /**
028     * Reads a line from the session input,
029     * blocking until a new line is available.
030     * @return not null
031     * @throws Exception
032     */
033    String readLine() throws Exception;
034
035    /**
036     * Writes a line to the session output.
037     * @param line not null
038     * @throws Exception
039     */
040    void writeLine(String line) throws Exception;
041
042    /**
043     * Opens the session.
044     * 
045     * @throws Exception
046     */
047    void start() throws Exception;
048
049    /**
050     * Reopens the session to reinitialize the server state
051     * 
052     * @throws Exception
053     */
054    void restart() throws Exception;
055
056    /**
057     * Closes the session.
058     * 
059     * @throws Exception
060     */
061    void stop() throws Exception;
062}