/*************************************************************************
*
* $RCSfile: pipeConnector.java,v $
*
* $Revision: 1.2 $
*
* last change: $Author: hr $ $Date: 2003/03/26 12:32:56 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://www.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
package com.sun.star.lib.connections.pipe;
import com.sun.star.comp.loader.FactoryHelper;
import com.sun.star.connection.ConnectionSetupException;
import com.sun.star.connection.NoConnectException;
import com.sun.star.connection.XConnection;
import com.sun.star.connection.XConnector;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.lang.XSingleServiceFactory;
import com.sun.star.registry.XRegistryKey;
import java.io.IOException;
import java.net.InetAddress;
import java.net.UnknownHostException;
/**
* A component that implements the <code>XConnector</code> interface.
*
* <p>The <code>pipeConnector</code> is a specialized component that uses TCP
* pipes for communication. The <code>pipeConnector</code> is generally
* used by the <code>com.sun.star.connection.Connector</code> service.</p>
*
* @see com.sun.star.connections.XAcceptor
* @see com.sun.star.connections.XConnection
* @see com.sun.star.connections.XConnector
* @see com.sun.star.loader.JavaLoader
*
* @since UDK 1.0
*/
public final class pipeConnector implements XConnector {
/**
* The name of the service.
*
* <p>The <code>JavaLoader</code> acceses this through reflection.</p>
*
* @see com.sun.star.comp.loader.JavaLoader
*/
public static final String __serviceName = "com.sun.star.connection.pipeConnector";
/**
* Returns a factory for creating the service.
*
* <p>This method is called by the <code>JavaLoader</code>.</p>
*
* @param implName the name of the implementation for which a service is
* requested.
* @param multiFactory the service manager to be used (if needed).
* @param regKey the registry key.
* @return an <code>XSingleServiceFactory</code> for creating the component.
*
* @see com.sun.star.comp.loader.JavaLoader
*/
public static XSingleServiceFactory __getServiceFactory(
String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)
{
return implName.equals(pipeConnector.class.getName())
? FactoryHelper.getServiceFactory(pipeConnector.class,
__serviceName, multiFactory,
regKey)
: null;
}
/**
* Writes the service information into the given registry key.
*
* <p>This method is called by the <code>JavaLoader</code>.</p>
*
* @param regKey the registry key.
* @return <code>true</code> if the operation succeeded.
*
* @see com.sun.star.comp.loader.JavaLoader
*/
public static boolean __writeRegistryServiceInfo(XRegistryKey regKey) {
return FactoryHelper.writeRegistryServiceInfo(
pipeConnector.class.getName(), __serviceName, regKey);
}
/**
* Connects via the described pipe to a waiting server.
*
* <p>The connection description has the following format:
* <code><var>type</var></code><!--
* -->*(<code><var>key</var>=<var>value</var></code>),
* where <code><var>type</var></code> should be <code>pipe</code>
* (ignoring case). Supported keys (ignoring case) currently are
* <dl>
* <dt><code>host</code>
* <dd>The name or address of the server. Must be present.
* <dt><code>port</code>
* <dd>The TCP port number of the server (defaults to <code>6001</code>).
* <dt><code>tcpnodelay</code>
* <dd>A flag (<code>0</code>/<code>1</code>) enabling or disabling Nagle's
* algorithm on the resulting connection.
* </dl></p>
*
* @param connectionDescription the description of the connection.
* @return an <code>XConnection</code> to the server.
*
* @see com.sun.star.connections.XAcceptor
* @see com.sun.star.connections.XConnection
*/
public synchronized XConnection connect(String connectionDescription)
throws NoConnectException, ConnectionSetupException
{
if (bConnected) {
throw new ConnectionSetupException("alread connected");
}
try
{
XConnection xConn = new PipeConnection( connectionDescription );
bConnected = true;
return xConn;
}
catch ( java.io.IOException e ) { throw new NoConnectException(); }
}
private boolean bConnected = false;
}