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   * @author Daniel F. Savarese
35   * @see SocketOutputStream
36   ***/
37  
38  public class SocketInputStream extends FilterInputStream
39  {
40      private Socket __socket;
41  
42      /***
43       * Creates a SocketInputStream instance wrapping an input stream and
44       * storing a reference to a socket that should be closed on closing
45       * the stream.
46       * <p>
47       * @param socket  The socket to close on closing the stream.
48       * @param stream  The input stream to wrap.
49       ***/
50      public SocketInputStream(Socket socket, InputStream stream)
51      {
52          super(stream);
53          __socket = socket;
54      }
55  
56      /***
57       * Closes the stream and immediately afterward closes the referenced
58       * socket.
59       * <p>
60       * @exception IOException  If there is an error in closing the stream
61       *                         or socket.
62       ***/
63      @Override
64      public void close() throws IOException
65      {
66          super.close();
67          __socket.close();
68      }
69  }