    001/*
    002 * Licensed to the Apache Software Foundation (ASF) under one or more
    003 * contributor license agreements.  See the NOTICE file distributed with
    004 * this work for additional information regarding copyright ownership.
    005 * The ASF licenses this file to You under the Apache License, Version 2.0
    006 * (the "License"); you may not use this file except in compliance with
    007 * the License.  You may obtain a copy of the License at
    008 *
    009 *      https://www.apache.org/licenses/LICENSE-2.0
    010 *
    011 * Unless required by applicable law or agreed to in writing, software
    012 * distributed under the License is distributed on an "AS IS" BASIS,
    013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    014 * See the License for the specific language governing permissions and
    015 * limitations under the License.
    016 */
    017
    018package org.apache.commons.net.io;
    019
    020import java.io.FilterInputStream;
    021import java.io.IOException;
    022import java.io.InputStream;
    023import java.net.Socket;
    024
    025/**
    026 * 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
    027 * 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
    028 * want to make sure it closes when the stream closes.
    029 *
    030 * @see SocketOutputStream
    031 */
    032public class SocketInputStream extends FilterInputStream {
    033    private final Socket socket;
    034
    035    /**
    036     * Creates a SocketInputStream instance wrapping an input stream and storing a reference to a socket that should be closed on closing the stream.
    037     *
    038     * @param socket The socket to close on closing the stream.
    039     * @param stream The input stream to wrap.
    040     */
    041    public SocketInputStream(final Socket socket, final InputStream stream) {
    042        super(stream);
    043        this.socket = socket;
    044    }
    045
    046    /**
    047     * Closes the stream and immediately afterward closes the referenced socket.
    048     *
    049     * @throws IOException If there is an error in closing the stream or socket.
    050     */
    051    @Override
    052    public void close() throws IOException {
    053        super.close();
    054        socket.close();
    055    }
    056}