- /*
- * Copyright 2001-2004 The Apache Software Foundation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- package org.apache.commons.net.io;
- import java.io.FilterInputStream;
- import java.io.IOException;
- import java.io.InputStream;
- import java.net.Socket;
-
- /***
- * This class wraps an input stream, storing a reference to its originating
- * socket. When the stream is closed, it will also close the socket
- * immediately afterward. This class is useful for situations where you
- * are dealing with a stream originating from a socket, but do not have
- * a reference to the socket, and want to make sure it closes when the
- * stream closes.
- * <p>
- * <p>
- * @author Daniel F. Savarese
- * @see SocketOutputStream
- ***/
-
- public class SocketInputStream extends FilterInputStream
- {
- private Socket __socket;
-
- /***
- * Creates a SocketInputStream instance wrapping an input stream and
- * storing a reference to a socket that should be closed on closing
- * the stream.
- * <p>
- * @param socket The socket to close on closing the stream.
- * @param stream The input stream to wrap.
- ***/
- public SocketInputStream(Socket socket, InputStream stream)
- {
- super(stream);
- __socket = socket;
- }
-
- /***
- * Closes the stream and immediately afterward closes the referenced
- * socket.
- * <p>
- * @exception IOException If there is an error in closing the stream
- * or socket.
- ***/
- public void close() throws IOException
- {
- super.close();
- __socket.close();
- }
- }