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.FilterOutputStream; 21 import java.io.IOException; 22 import java.io.OutputStream; 23 import java.net.Socket; 24 25 /*** 26 * This class wraps an output 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 SocketInputStream 35 ***/ 36 37 public class SocketOutputStream extends FilterOutputStream 38 { 39 private final Socket __socket; 40 41 /*** 42 * Creates a SocketOutputStream instance wrapping an output 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 SocketOutputStream(Socket socket, OutputStream stream) 50 { 51 super(stream); 52 __socket = socket; 53 } 54 55 56 /*** 57 * Writes a number of bytes from a byte array to the stream starting from 58 * a given offset. This method bypasses the equivalent method in 59 * FilterOutputStream because the FilterOutputStream implementation is 60 * very inefficient. 61 * <p> 62 * @param buffer The byte array to write. 63 * @param offset The offset into the array at which to start copying data. 64 * @param length The number of bytes to write. 65 * @exception IOException If an error occurs while writing to the underlying 66 * stream. 67 ***/ 68 @Override 69 public void write(byte buffer[], int offset, int length) throws IOException 70 { 71 out.write(buffer, offset, length); 72 } 73 74 75 /*** 76 * Closes the stream and immediately afterward closes the referenced 77 * socket. 78 * <p> 79 * @exception IOException If there is an error in closing the stream 80 * or socket. 81 ***/ 82 @Override 83 public void close() throws IOException 84 { 85 super.close(); 86 __socket.close(); 87 } 88 }