View Javadoc

1   /****************************************************************
2    * Licensed to the Apache Software Foundation (ASF) under one   *
3    * or more contributor license agreements.  See the NOTICE file *
4    * distributed with this work for additional information        *
5    * regarding copyright ownership.  The ASF licenses this file   *
6    * to you under the Apache License, Version 2.0 (the            *
7    * "License"); you may not use this file except in compliance   *
8    * with the License.  You may obtain a copy of the License at   *
9    *                                                              *
10   *   http://www.apache.org/licenses/LICENSE-2.0                 *
11   *                                                              *
12   * Unless required by applicable law or agreed to in writing,   *
13   * software distributed under the License is distributed on an  *
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
15   * KIND, either express or implied.  See the License for the    *
16   * specific language governing permissions and limitations      *
17   * under the License.                                           *
18   ****************************************************************/
19  
20  package org.apache.james.mpt;
21  
22  /**
23   * A connection to the host.
24   */
25  public interface Session {
26      
27      /**
28       * Reads a line from the session input,
29       * blocking until a new line is available.
30       * @return not null
31       * @throws Exception
32       */
33      public String readLine() throws Exception;
34  
35      /**
36       * Writes a line to the session output.
37       * @param line not null
38       * @throws Exception
39       */
40      public void writeLine(String line) throws Exception;
41  
42      /**
43       * Opens the session.
44       * 
45       * @throws Exception
46       */
47      public void start() throws Exception;
48  
49      /**
50       * Closes the session.
51       * 
52       * @throws Exception
53       */
54      public void stop() throws Exception;
55  }