View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package org.apache.commons.net.io;
19  
20  import java.io.FilterInputStream;
21  import java.io.IOException;
22  import java.io.InputStream;
23  import java.net.Socket;
24  
25  /***
26   * This class wraps an input stream, storing a reference to its originating
27   * socket.  When the stream is closed, it will also close the socket
28   * immediately afterward.  This class is useful for situations where you
29   * are dealing with a stream originating from a socket, but do not have
30   * a reference to the socket, and want to make sure it closes when the
31   * stream closes.
32   * <p>
33   * <p>
34   * @see SocketOutputStream
35   ***/
36  
37  public class SocketInputStream extends FilterInputStream
38  {
39      private final Socket __socket;
40  
41      /***
42       * Creates a SocketInputStream instance wrapping an input stream and
43       * storing a reference to a socket that should be closed on closing
44       * the stream.
45       * <p>
46       * @param socket  The socket to close on closing the stream.
47       * @param stream  The input stream to wrap.
48       ***/
49      public SocketInputStream(Socket socket, InputStream stream)
50      {
51          super(stream);
52          __socket = socket;
53      }
54  
55      /***
56       * Closes the stream and immediately afterward closes the referenced
57       * socket.
58       * <p>
59       * @exception IOException  If there is an error in closing the stream
60       *                         or socket.
61       ***/
62      @Override
63      public void close() throws IOException
64      {
65          super.close();
66          __socket.close();
67      }
68  }