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 24*b1cdbd2cSJim Jagielski package com.sun.star.lib.connections.pipe; 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski import com.sun.star.comp.loader.FactoryHelper; 27*b1cdbd2cSJim Jagielski import com.sun.star.connection.ConnectionSetupException; 28*b1cdbd2cSJim Jagielski import com.sun.star.connection.NoConnectException; 29*b1cdbd2cSJim Jagielski import com.sun.star.connection.XConnection; 30*b1cdbd2cSJim Jagielski import com.sun.star.connection.XConnector; 31*b1cdbd2cSJim Jagielski import com.sun.star.lang.XMultiServiceFactory; 32*b1cdbd2cSJim Jagielski import com.sun.star.lang.XSingleServiceFactory; 33*b1cdbd2cSJim Jagielski import com.sun.star.registry.XRegistryKey; 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski /** 36*b1cdbd2cSJim Jagielski * A component that implements the <code>XConnector</code> interface. 37*b1cdbd2cSJim Jagielski * 38*b1cdbd2cSJim Jagielski * <p>The <code>pipeConnector</code> is a specialized component that uses TCP 39*b1cdbd2cSJim Jagielski * pipes for communication. The <code>pipeConnector</code> is generally 40*b1cdbd2cSJim Jagielski * used by the <code>com.sun.star.connection.Connector</code> service.</p> 41*b1cdbd2cSJim Jagielski * 42*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XAcceptor 43*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection 44*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnector 45*b1cdbd2cSJim Jagielski * @see com.sun.star.loader.JavaLoader 46*b1cdbd2cSJim Jagielski * 47*b1cdbd2cSJim Jagielski * @since UDK 1.0 48*b1cdbd2cSJim Jagielski */ 49*b1cdbd2cSJim Jagielski public final class pipeConnector implements XConnector { 50*b1cdbd2cSJim Jagielski /** 51*b1cdbd2cSJim Jagielski * The name of the service. 52*b1cdbd2cSJim Jagielski * 53*b1cdbd2cSJim Jagielski * <p>The <code>JavaLoader</code> acceses this through reflection.</p> 54*b1cdbd2cSJim Jagielski * 55*b1cdbd2cSJim Jagielski * @see com.sun.star.comp.loader.JavaLoader 56*b1cdbd2cSJim Jagielski */ 57*b1cdbd2cSJim Jagielski public static final String __serviceName = "com.sun.star.connection.pipeConnector"; 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski /** 60*b1cdbd2cSJim Jagielski * Returns a factory for creating the service. 61*b1cdbd2cSJim Jagielski * 62*b1cdbd2cSJim Jagielski * <p>This method is called by the <code>JavaLoader</code>.</p> 63*b1cdbd2cSJim Jagielski * 64*b1cdbd2cSJim Jagielski * @param implName the name of the implementation for which a service is 65*b1cdbd2cSJim Jagielski * requested. 66*b1cdbd2cSJim Jagielski * @param multiFactory the service manager to be used (if needed). 67*b1cdbd2cSJim Jagielski * @param regKey the registry key. 68*b1cdbd2cSJim Jagielski * @return an <code>XSingleServiceFactory</code> for creating the component. 69*b1cdbd2cSJim Jagielski * 70*b1cdbd2cSJim Jagielski * @see com.sun.star.comp.loader.JavaLoader 71*b1cdbd2cSJim Jagielski */ __getServiceFactory( String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)72*b1cdbd2cSJim Jagielski public static XSingleServiceFactory __getServiceFactory( 73*b1cdbd2cSJim Jagielski String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey) 74*b1cdbd2cSJim Jagielski { 75*b1cdbd2cSJim Jagielski return implName.equals(pipeConnector.class.getName()) 76*b1cdbd2cSJim Jagielski ? FactoryHelper.getServiceFactory(pipeConnector.class, 77*b1cdbd2cSJim Jagielski __serviceName, multiFactory, 78*b1cdbd2cSJim Jagielski regKey) 79*b1cdbd2cSJim Jagielski : null; 80*b1cdbd2cSJim Jagielski } 81*b1cdbd2cSJim Jagielski 82*b1cdbd2cSJim Jagielski /** 83*b1cdbd2cSJim Jagielski * Connects via the described pipe to a waiting server. 84*b1cdbd2cSJim Jagielski * 85*b1cdbd2cSJim Jagielski * <p>The connection description has the following format: 86*b1cdbd2cSJim Jagielski * <code><var>type</var></code><!-- 87*b1cdbd2cSJim Jagielski * -->*(<code><var>key</var>=<var>value</var></code>), 88*b1cdbd2cSJim Jagielski * where <code><var>type</var></code> should be <code>pipe</code> 89*b1cdbd2cSJim Jagielski * (ignoring case). Supported keys (ignoring case) currently are 90*b1cdbd2cSJim Jagielski * <dl> 91*b1cdbd2cSJim Jagielski * <dt><code>host</code> 92*b1cdbd2cSJim Jagielski * <dd>The name or address of the server. Must be present. 93*b1cdbd2cSJim Jagielski * <dt><code>port</code> 94*b1cdbd2cSJim Jagielski * <dd>The TCP port number of the server (defaults to <code>6001</code>). 95*b1cdbd2cSJim Jagielski * <dt><code>tcpnodelay</code> 96*b1cdbd2cSJim Jagielski * <dd>A flag (<code>0</code>/<code>1</code>) enabling or disabling Nagle's 97*b1cdbd2cSJim Jagielski * algorithm on the resulting connection. 98*b1cdbd2cSJim Jagielski * </dl></p> 99*b1cdbd2cSJim Jagielski * 100*b1cdbd2cSJim Jagielski * @param connectionDescription the description of the connection. 101*b1cdbd2cSJim Jagielski * @return an <code>XConnection</code> to the server. 102*b1cdbd2cSJim Jagielski * 103*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XAcceptor 104*b1cdbd2cSJim Jagielski * @see com.sun.star.connections.XConnection 105*b1cdbd2cSJim Jagielski */ connect(String connectionDescription)106*b1cdbd2cSJim Jagielski public synchronized XConnection connect(String connectionDescription) 107*b1cdbd2cSJim Jagielski throws NoConnectException, ConnectionSetupException 108*b1cdbd2cSJim Jagielski { 109*b1cdbd2cSJim Jagielski if (bConnected) { 110*b1cdbd2cSJim Jagielski throw new ConnectionSetupException("alread connected"); 111*b1cdbd2cSJim Jagielski } 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski try 114*b1cdbd2cSJim Jagielski { 115*b1cdbd2cSJim Jagielski XConnection xConn = new PipeConnection( connectionDescription ); 116*b1cdbd2cSJim Jagielski bConnected = true; 117*b1cdbd2cSJim Jagielski return xConn; 118*b1cdbd2cSJim Jagielski } 119*b1cdbd2cSJim Jagielski catch ( java.io.IOException e ) { throw new NoConnectException(); } 120*b1cdbd2cSJim Jagielski } 121*b1cdbd2cSJim Jagielski 122*b1cdbd2cSJim Jagielski private boolean bConnected = false; 123*b1cdbd2cSJim Jagielski } 124