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 socket. When the stream is closed, it will also close the socket immediately 27 * 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 28 * want to make sure it closes when the stream closes. 29 * 30 * 31 * @see SocketInputStream 32 */ 33 34 public class SocketOutputStream extends FilterOutputStream { 35 private final Socket socket; 36 37 /** 38 * Creates a SocketOutputStream instance wrapping an output stream and storing a reference to a socket that should be closed on closing the stream. 39 * 40 * @param socket The socket to close on closing the stream. 41 * @param stream The input stream to wrap. 42 */ 43 public SocketOutputStream(final Socket socket, final OutputStream stream) { 44 super(stream); 45 this.socket = socket; 46 } 47 48 /** 49 * Closes the stream and immediately afterward closes the referenced socket. 50 * 51 * @throws IOException If there is an error in closing the stream or socket. 52 */ 53 @Override 54 public void close() throws IOException { 55 super.close(); 56 socket.close(); 57 } 58 59 /** 60 * Writes a number of bytes from a byte array to the stream starting from a given offset. This method bypasses the equivalent method in FilterOutputStream 61 * because the FilterOutputStream implementation is very inefficient. 62 * 63 * @param buffer The byte array to write. 64 * @param offset The offset into the array at which to start copying data. 65 * @param length The number of bytes to write. 66 * @throws IOException If an error occurs while writing to the underlying stream. 67 */ 68 @Override 69 public void write(final byte buffer[], final int offset, final int length) throws IOException { 70 out.write(buffer, offset, length); 71 } 72 }