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