View Javadoc

1   /*
2    * Copyright 2009-2009 CommonsSSH Project.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package net.sf.commons.ssh;
17  
18  import java.io.IOException;
19  
20  /***
21   * @author Sergey Vidyuk (svidyuk at gmail dot com)
22   * 
23   */
24  public interface Session {
25  
26      /***
27       * Closes this session.
28       * 
29       * @throws IOException
30       *             if I/O exception occurs
31       * @since 1.0
32       */
33      void close() throws IOException;
34  
35      /***
36       * Returns <code>true</code> if session is closed already,
37       * <code>false</code> otherwise
38       * 
39       * @return <code>true</code> if session is closed already,
40       * @throws IOException
41       *             if I/O exception occurs
42       * @since 1.0
43       */
44      public abstract boolean isClosed() throws IOException;
45  
46  }