jurt/com/sun/star/lib/connections/socket/SocketConnection.java

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SocketConnection.java,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 package com.sun.star.lib.connections.socket;
  31
  32
  33 import java.io.BufferedInputStream;
  34 import java.io.BufferedOutputStream;
  35 import java.io.InputStream;
  36 import java.io.IOException;
  37 import java.io.OutputStream;
  38
  39 import java.net.Socket;
  40
  41 import java.util.Enumeration;
  42 import java.util.Vector;
  43
  44
  45 import com.sun.star.io.XStreamListener;
  46
  47 import com.sun.star.connection.XConnection;
  48 import com.sun.star.connection.XConnectionBroadcaster;
  49
  50 /**
  51  * The SocketConnection implements the <code>XConnection</code> interface
  52  * and is uses by the <code>SocketConnector</code> and the <code>SocketAcceptor</code>.
  53  * This class is not part of the provided <code>api</code>.
  54  * <p>
  55  * @version     $Revision: 1.6 $ $ $Date: 2008-04-11 11:14:31 $
  56  * @author          Kay Ramme
  57  * @see         com.sun.star.comp.connections.SocketAcceptor
  58  * @see         com.sun.star.comp.connections.SocketConnector
  59  * @see         com.sun.star.connections.XConnection
  60  * @since       UDK1.0
  61  */
  62 public class SocketConnection implements XConnection, XConnectionBroadcaster {
  63     /**
  64      * When set to true, enables various debugging output.
  65      */
  66     static public final boolean DEBUG = false;
  67
  68     protected String       _description;
  69     protected Socket       _socket;
  70     protected InputStream  _inputStream;
  71     protected OutputStream _outputStream;
  72     protected Vector       _listeners;
  73     protected boolean      _firstRead;
  74
  75     /**
  76      * Constructs a new <code>SocketConnection</code>.
  77      * <p>
  78      * @param  description   the description of the connection
  79      * @param  socket        the socket of the connection
  80      */
  81     public SocketConnection(String description, Socket socket) throws IOException {
  82         if (DEBUG) System.err.println("##### " + getClass().getName() + " - instantiated " + description + " " + socket);
  83
  84         _description = description
  85             + ",localHost=" + socket.getLocalAddress().getHostName()
  86             + ",localPort=" + socket.getLocalPort()
  87             + ",peerHost=" + socket.getInetAddress().getHostName()
  88             + ",peerPort=" + socket.getPort();
  89
  90         _socket = socket;
  91         _inputStream = new BufferedInputStream(socket.getInputStream());
  92         _outputStream = new BufferedOutputStream(socket.getOutputStream());
  93
  94         _listeners = new Vector();
  95         _firstRead = true;
  96     }
  97
  98
  99
 100
 101     public void addStreamListener(XStreamListener aListener ) throws com.sun.star.uno.RuntimeException {
 102         _listeners.addElement(aListener);
 103     }
 104
 105     public void removeStreamListener(XStreamListener aListener ) throws com.sun.star.uno.RuntimeException {
 106         _listeners.removeElement(aListener);
 107     }
 108
 109     private void notifyListeners_open() {
 110         Enumeration elements = _listeners.elements();
 111         while(elements.hasMoreElements()) {
 112             XStreamListener xStreamListener = (XStreamListener)elements.nextElement();
 113             xStreamListener.started();
 114         }
 115     }
 116
 117     private void notifyListeners_close() {
 118         Enumeration elements = _listeners.elements();
 119         while(elements.hasMoreElements()) {
 120             XStreamListener xStreamListener = (XStreamListener)elements.nextElement();
 121             xStreamListener.closed();
 122         }
 123     }
 124
 125     private void notifyListeners_error(com.sun.star.uno.Exception exception) {
 126         Enumeration elements = _listeners.elements();
 127         while(elements.hasMoreElements()) {
 128             XStreamListener xStreamListener = (XStreamListener)elements.nextElement();
 129             xStreamListener.error(exception);
 130         }
 131     }
 132
 133
 134     /**
 135      * Read the required number of bytes.
 136      * <p>
 137      * @return   the number of bytes read
 138      * @param    aReadBytes   the outparameter, where the bytes have to be placed
 139      * @param    nBytesToRead the number of bytes to read
 140      * @see       com.sun.star.connections.XConnection#read
 141      */
 142     public int read(/*OUT*/byte[][] bytes, int nBytesToRead) throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException {
 143         if(_firstRead) {
 144             _firstRead = false;
 145
 146             notifyListeners_open();
 147         }
 148
 149         String errMessage = null;
 150
 151         int read_bytes = 0;
 152         bytes[0] = new byte[nBytesToRead];
 153
 154         try {
 155             int count = 0;
 156
 157             do {
 158                 count = _inputStream.read(bytes[0], read_bytes, nBytesToRead - read_bytes);
 159                 if(count == -1)
 160                     errMessage = "EOF reached - " + getDescription();
 161
 162                 read_bytes += count;
 163             }
 164             while(read_bytes >= 0 && read_bytes < nBytesToRead && count >= 0);
 165         }
 166         catch(IOException ioException) {
 167             if(DEBUG) {
 168                 System.err.println("##### " + getClass().getName() + ".read - exception occurred:" + ioException);
 169                 ioException.printStackTrace();
 170             }
 171
 172             errMessage = ioException.toString();
 173         }
 174
 175         if(errMessage != null) {
 176             com.sun.star.io.IOException unoIOException = new com.sun.star.io.IOException(errMessage);
 177             notifyListeners_error(unoIOException);
 178
 179             throw unoIOException;
 180         }
 181
 182         if (DEBUG) System.err.println("##### " + getClass().getName() + " - read byte:" + read_bytes + " " + bytes[0]);
 183
 184         return read_bytes;
 185     }
 186
 187     /**
 188      * Write bytes.
 189      * <p>
 190      * @param    aData the bytes to write
 191      * @see       com.sun.star.connections.XConnection#write
 192      */
 193     public void write(byte aData[]) throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException {
 194         try {
 195             _outputStream.write(aData);
 196         }
 197         catch(IOException ioException) {
 198             com.sun.star.io.IOException unoIOException = new com.sun.star.io.IOException(ioException.toString());
 199             notifyListeners_error(unoIOException);
 200
 201             throw unoIOException;
 202         }
 203
 204         if (DEBUG) System.err.println("##### " + getClass().getName() + " - written bytes:" + aData + " " + aData.length);
 205     }
 206
 207     /**
 208      * Flushes the buffer.
 209      * <p>
 210      * @see       com.sun.star.connections.XConnection#flush
 211      */
 212     public void flush() throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException {
 213         try {
 214             _outputStream.flush();
 215         }
 216         catch(IOException ioException) {
 217             com.sun.star.io.IOException unoIOException = new com.sun.star.io.IOException(ioException.toString());
 218             notifyListeners_error(unoIOException);
 219
 220             throw unoIOException;
 221         }
 222     }
 223
 224     /**
 225      * Closes the connection.
 226      * <p>
 227      * @see       com.sun.star.connections.XConnection#close
 228      */
 229     public void close() throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException {
 230         try {
 231             _socket.close();
 232         }
 233         catch(IOException ioException) {
 234             com.sun.star.io.IOException unoIOException = new com.sun.star.io.IOException(ioException.toString());
 235             notifyListeners_error(unoIOException);
 236
 237             throw unoIOException;
 238         }
 239         if (DEBUG) System.err.println("##### " + getClass().getName() + " - socket closed");
 240
 241         notifyListeners_close();
 242     }
 243
 244     /**
 245      * Gives a description of the connection.
 246      * <p>
 247      * @return  the description
 248      * @see       com.sun.star.connections.XConnection#getDescription
 249      */
 250     public String getDescription() throws com.sun.star.uno.RuntimeException {
 251         return _description;
 252     }
 253
 254 }
 255