1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski package com.sun.star.lib.connections.pipe; 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski import java.io.IOException; 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski import java.util.StringTokenizer; 28*b1cdbd2cSJim Jagielski import java.util.Enumeration; 29*b1cdbd2cSJim Jagielski import java.util.Vector; 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski import com.sun.star.lib.util.NativeLibraryLoader; 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski import com.sun.star.io.XStreamListener; 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski import com.sun.star.connection.XConnection; 36*b1cdbd2cSJim Jagielski import com.sun.star.connection.XConnectionBroadcaster; 37*b1cdbd2cSJim Jagielski 38*b1cdbd2cSJim Jagielski /** 39*b1cdbd2cSJim Jagielski * The PipeConnection implements the <code>XConnection</code> interface 40*b1cdbd2cSJim Jagielski * and is uses by the <code>PipeConnector</code> and the <code>PipeAcceptor</code>. 41*b1cdbd2cSJim Jagielski * This class is not part of the provided <code>api</code>. 42*b1cdbd2cSJim Jagielski * <p> 43*b1cdbd2cSJim Jagielski * @version $Revision: 1.7 $ $ $Date: 2008-04-11 11:13:00 $ 44*b1cdbd2cSJim Jagielski * @author Kay Ramme 45*b1cdbd2cSJim Jagielski * @see com.sun.star.comp.connections.PipeAcceptor 46*b1cdbd2cSJim Jagielski * @see com.sun.star.comp.connections.PipeConnector 47*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection 48*b1cdbd2cSJim Jagielski * @since UDK1.0 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski public class PipeConnection implements XConnection, XConnectionBroadcaster { 51*b1cdbd2cSJim Jagielski /** 52*b1cdbd2cSJim Jagielski * When set to true, enables various debugging output. 53*b1cdbd2cSJim Jagielski */ 54*b1cdbd2cSJim Jagielski static public final boolean DEBUG = false; 55*b1cdbd2cSJim Jagielski 56*b1cdbd2cSJim Jagielski static { 57*b1cdbd2cSJim Jagielski // load shared library for JNI code PipeConnection.class.getClassLoader()58*b1cdbd2cSJim Jagielski NativeLibraryLoader.loadLibrary(PipeConnection.class.getClassLoader(), "jpipe"); 59*b1cdbd2cSJim Jagielski } 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski protected String _aDescription; 62*b1cdbd2cSJim Jagielski protected long _nPipeHandle; 63*b1cdbd2cSJim Jagielski protected Vector _aListeners; 64*b1cdbd2cSJim Jagielski protected boolean _bFirstRead; 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski /** 67*b1cdbd2cSJim Jagielski * Constructs a new <code>PipeConnection</code>. 68*b1cdbd2cSJim Jagielski * <p> 69*b1cdbd2cSJim Jagielski * @param description the description of the connection 70*b1cdbd2cSJim Jagielski * @param pipe the pipe of the connection 71*b1cdbd2cSJim Jagielski */ PipeConnection(String description)72*b1cdbd2cSJim Jagielski public PipeConnection(String description) 73*b1cdbd2cSJim Jagielski throws IOException 74*b1cdbd2cSJim Jagielski { 75*b1cdbd2cSJim Jagielski if (DEBUG) System.err.println("##### " + getClass().getName() + " - instantiated " + description ); 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski _aListeners = new Vector(); 78*b1cdbd2cSJim Jagielski _bFirstRead = true; 79*b1cdbd2cSJim Jagielski 80*b1cdbd2cSJim Jagielski // get pipe name from pipe descriptor 81*b1cdbd2cSJim Jagielski String aPipeName ; 82*b1cdbd2cSJim Jagielski StringTokenizer aTokenizer = new StringTokenizer( description, "," ); 83*b1cdbd2cSJim Jagielski if ( aTokenizer.hasMoreTokens() ) 84*b1cdbd2cSJim Jagielski { 85*b1cdbd2cSJim Jagielski String aConnType = aTokenizer.nextToken(); 86*b1cdbd2cSJim Jagielski if ( !aConnType.equals( "pipe" ) ) 87*b1cdbd2cSJim Jagielski throw new RuntimeException( "invalid pipe descriptor: does not start with 'pipe,'" ); 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski String aPipeNameParam = aTokenizer.nextToken(); 90*b1cdbd2cSJim Jagielski if ( !aPipeNameParam.substring( 0, 5 ).equals( "name=" ) ) 91*b1cdbd2cSJim Jagielski throw new RuntimeException( "invalid pipe descriptor: no 'name=' parameter found" ); 92*b1cdbd2cSJim Jagielski aPipeName = aPipeNameParam.substring( 5 ); 93*b1cdbd2cSJim Jagielski } 94*b1cdbd2cSJim Jagielski else 95*b1cdbd2cSJim Jagielski throw new RuntimeException( "invalid or empty pipe descriptor" ); 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski // create the pipe 98*b1cdbd2cSJim Jagielski try 99*b1cdbd2cSJim Jagielski { createJNI( aPipeName ); } 100*b1cdbd2cSJim Jagielski catch ( java.lang.NullPointerException aNPE ) 101*b1cdbd2cSJim Jagielski { throw new IOException( aNPE.getMessage() ); } 102*b1cdbd2cSJim Jagielski catch ( com.sun.star.io.IOException aIOE ) 103*b1cdbd2cSJim Jagielski { throw new IOException( aIOE.getMessage() ); } 104*b1cdbd2cSJim Jagielski catch ( java.lang.Exception aE ) 105*b1cdbd2cSJim Jagielski { throw new IOException( aE.getMessage() ); } 106*b1cdbd2cSJim Jagielski } 107*b1cdbd2cSJim Jagielski addStreamListener(XStreamListener aListener )108*b1cdbd2cSJim Jagielski public void addStreamListener(XStreamListener aListener ) throws com.sun.star.uno.RuntimeException { 109*b1cdbd2cSJim Jagielski _aListeners.addElement(aListener); 110*b1cdbd2cSJim Jagielski } 111*b1cdbd2cSJim Jagielski removeStreamListener(XStreamListener aListener )112*b1cdbd2cSJim Jagielski public void removeStreamListener(XStreamListener aListener ) throws com.sun.star.uno.RuntimeException { 113*b1cdbd2cSJim Jagielski _aListeners.removeElement(aListener); 114*b1cdbd2cSJim Jagielski } 115*b1cdbd2cSJim Jagielski notifyListeners_open()116*b1cdbd2cSJim Jagielski private void notifyListeners_open() { 117*b1cdbd2cSJim Jagielski Enumeration elements = _aListeners.elements(); 118*b1cdbd2cSJim Jagielski while(elements.hasMoreElements()) { 119*b1cdbd2cSJim Jagielski XStreamListener xStreamListener = (XStreamListener)elements.nextElement(); 120*b1cdbd2cSJim Jagielski xStreamListener.started(); 121*b1cdbd2cSJim Jagielski } 122*b1cdbd2cSJim Jagielski } 123*b1cdbd2cSJim Jagielski notifyListeners_close()124*b1cdbd2cSJim Jagielski private void notifyListeners_close() { 125*b1cdbd2cSJim Jagielski Enumeration elements = _aListeners.elements(); 126*b1cdbd2cSJim Jagielski while(elements.hasMoreElements()) { 127*b1cdbd2cSJim Jagielski XStreamListener xStreamListener = (XStreamListener)elements.nextElement(); 128*b1cdbd2cSJim Jagielski xStreamListener.closed(); 129*b1cdbd2cSJim Jagielski } 130*b1cdbd2cSJim Jagielski } 131*b1cdbd2cSJim Jagielski notifyListeners_error(com.sun.star.uno.Exception exception)132*b1cdbd2cSJim Jagielski private void notifyListeners_error(com.sun.star.uno.Exception exception) { 133*b1cdbd2cSJim Jagielski Enumeration elements = _aListeners.elements(); 134*b1cdbd2cSJim Jagielski while(elements.hasMoreElements()) { 135*b1cdbd2cSJim Jagielski XStreamListener xStreamListener = (XStreamListener)elements.nextElement(); 136*b1cdbd2cSJim Jagielski xStreamListener.error(exception); 137*b1cdbd2cSJim Jagielski } 138*b1cdbd2cSJim Jagielski } 139*b1cdbd2cSJim Jagielski 140*b1cdbd2cSJim Jagielski // JNI implementation to create the pipe createJNI( String name )141*b1cdbd2cSJim Jagielski private native int createJNI( String name ) 142*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException; 143*b1cdbd2cSJim Jagielski 144*b1cdbd2cSJim Jagielski // JNI implementation to read from the pipe readJNI( byte[][] bytes, int nBytesToRead)145*b1cdbd2cSJim Jagielski private native int readJNI(/*OUT*/byte[][] bytes, int nBytesToRead) 146*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException; 147*b1cdbd2cSJim Jagielski 148*b1cdbd2cSJim Jagielski // JNI implementation to write to the pipe writeJNI(byte aData[])149*b1cdbd2cSJim Jagielski private native void writeJNI(byte aData[]) 150*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException; 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski // JNI implementation to flush the pipe flushJNI()153*b1cdbd2cSJim Jagielski private native void flushJNI() 154*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException; 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski // JNI implementation to close the pipe closeJNI()157*b1cdbd2cSJim Jagielski private native void closeJNI() 158*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException; 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski /** 161*b1cdbd2cSJim Jagielski * Read the required number of bytes. 162*b1cdbd2cSJim Jagielski * <p> 163*b1cdbd2cSJim Jagielski * @return the number of bytes read 164*b1cdbd2cSJim Jagielski * @param aReadBytes the outparameter, where the bytes have to be placed 165*b1cdbd2cSJim Jagielski * @param nBytesToRead the number of bytes to read 166*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#read 167*b1cdbd2cSJim Jagielski */ read( byte[][] bytes, int nBytesToRead)168*b1cdbd2cSJim Jagielski public int read(/*OUT*/byte[][] bytes, int nBytesToRead) 169*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException 170*b1cdbd2cSJim Jagielski { 171*b1cdbd2cSJim Jagielski if(_bFirstRead) { 172*b1cdbd2cSJim Jagielski _bFirstRead = false; 173*b1cdbd2cSJim Jagielski 174*b1cdbd2cSJim Jagielski notifyListeners_open(); 175*b1cdbd2cSJim Jagielski } 176*b1cdbd2cSJim Jagielski 177*b1cdbd2cSJim Jagielski return readJNI( bytes, nBytesToRead ); 178*b1cdbd2cSJim Jagielski } 179*b1cdbd2cSJim Jagielski 180*b1cdbd2cSJim Jagielski /** 181*b1cdbd2cSJim Jagielski * Write bytes. 182*b1cdbd2cSJim Jagielski * <p> 183*b1cdbd2cSJim Jagielski * @param aData the bytes to write 184*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#write 185*b1cdbd2cSJim Jagielski */ write(byte aData[])186*b1cdbd2cSJim Jagielski public void write(byte aData[]) 187*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException 188*b1cdbd2cSJim Jagielski { 189*b1cdbd2cSJim Jagielski writeJNI( aData ); 190*b1cdbd2cSJim Jagielski } 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski /** 193*b1cdbd2cSJim Jagielski * Flushes the buffer. 194*b1cdbd2cSJim Jagielski * <p> 195*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#flush 196*b1cdbd2cSJim Jagielski */ flush()197*b1cdbd2cSJim Jagielski public void flush() 198*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException 199*b1cdbd2cSJim Jagielski { 200*b1cdbd2cSJim Jagielski flushJNI(); 201*b1cdbd2cSJim Jagielski } 202*b1cdbd2cSJim Jagielski 203*b1cdbd2cSJim Jagielski /** 204*b1cdbd2cSJim Jagielski * Closes the connection. 205*b1cdbd2cSJim Jagielski * <p> 206*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#close 207*b1cdbd2cSJim Jagielski */ close()208*b1cdbd2cSJim Jagielski public void close() 209*b1cdbd2cSJim Jagielski throws com.sun.star.io.IOException, com.sun.star.uno.RuntimeException 210*b1cdbd2cSJim Jagielski { 211*b1cdbd2cSJim Jagielski if (DEBUG) System.out.print( "PipeConnection::close() " ); 212*b1cdbd2cSJim Jagielski closeJNI(); 213*b1cdbd2cSJim Jagielski notifyListeners_close(); 214*b1cdbd2cSJim Jagielski if (DEBUG) System.out.println( "done" ); 215*b1cdbd2cSJim Jagielski } 216*b1cdbd2cSJim Jagielski 217*b1cdbd2cSJim Jagielski /** 218*b1cdbd2cSJim Jagielski * Gives a description of the connection. 219*b1cdbd2cSJim Jagielski * <p> 220*b1cdbd2cSJim Jagielski * @return the description 221*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection#getDescription 222*b1cdbd2cSJim Jagielski */ getDescription()223*b1cdbd2cSJim Jagielski public String getDescription() throws com.sun.star.uno.RuntimeException { 224*b1cdbd2cSJim Jagielski return _aDescription; 225*b1cdbd2cSJim Jagielski } 226*b1cdbd2cSJim Jagielski 227*b1cdbd2cSJim Jagielski } 228*b1cdbd2cSJim Jagielski 229