01: /*
02: * Copyright 2001-2005 The Apache Software Foundation
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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 org.apache.commons.net.io;
17:
18: import java.io.FilterInputStream;
19: import java.io.IOException;
20: import java.io.InputStream;
21: import java.net.Socket;
22:
23: /***
24: * This class wraps an input stream, storing a reference to its originating
25: * socket. When the stream is closed, it will also close the socket
26: * immediately afterward. This class is useful for situations where you
27: * are dealing with a stream originating from a socket, but do not have
28: * a reference to the socket, and want to make sure it closes when the
29: * stream closes.
30: * <p>
31: * <p>
32: * @author Daniel F. Savarese
33: * @see SocketOutputStream
34: ***/
35:
36: public class SocketInputStream extends FilterInputStream {
37: private Socket __socket;
38:
39: /***
40: * Creates a SocketInputStream instance wrapping an input stream and
41: * storing a reference to a socket that should be closed on closing
42: * the stream.
43: * <p>
44: * @param socket The socket to close on closing the stream.
45: * @param stream The input stream to wrap.
46: ***/
47: public SocketInputStream(Socket socket, InputStream stream) {
48: super (stream);
49: __socket = socket;
50: }
51:
52: /***
53: * Closes the stream and immediately afterward closes the referenced
54: * socket.
55: * <p>
56: * @exception IOException If there is an error in closing the stream
57: * or socket.
58: ***/
59: public void close() throws IOException {
60: super.close();
61: __socket.close();
62: }
63: }
|