com.sun.star.lib.connections.socket.socketConnector Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of libreoffice Show documentation
Show all versions of libreoffice Show documentation
Public UNO Java Classes (formerly jurt,juh,ridl,unoil)
/* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
package com.sun.star.lib.connections.socket;
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.Socket;
import java.net.UnknownHostException;
/**
* A component that implements the XConnector interface.
*
* The socketConnector is a specialized component that uses TCP
* sockets for communication. The socketConnector is generally
* used by the com.sun.star.connection.Connector service.
*
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
* @see com.sun.star.connection.XConnector
* @see com.sun.star.comp.loader.JavaLoader
*
* @since UDK 1.0
*/
public final class socketConnector implements XConnector {
/**
* The name of the service.
*
* The JavaLoader accesses this through reflection.
*
* @see com.sun.star.comp.loader.JavaLoader
*/
public static final String __serviceName
= "com.sun.star.connection.socketConnector";
/**
* Returns a factory for creating the service.
*
* This method is called by the JavaLoader.
*
* @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 XSingleServiceFactory for creating the component.
*
* @see com.sun.star.comp.loader.JavaLoader
*/
public static XSingleServiceFactory __getServiceFactory(
String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)
{
return implName.equals(socketConnector.class.getName())
? FactoryHelper.getServiceFactory(socketConnector.class,
__serviceName, multiFactory,
regKey)
: null;
}
/**
* Connects via the described socket to a waiting server.
*
* The connection description has the following format:
* type*(key=value),
* where type should be socket
* (ignoring case). Supported keys (ignoring case) currently are
*
* host
* - The name or address of the server. Must be present.
*
port
* - The TCP port number of the server (defaults to
6001).
* tcpnodelay
* - A flag (
0/1) enabling or disabling Nagle's
* algorithm on the resulting connection.
*
*
* @param connectionDescription the description of the connection.
* @return an XConnection to the server.
*
* @see com.sun.star.connection.XAcceptor
* @see com.sun.star.connection.XConnection
*/
public synchronized XConnection connect(String connectionDescription)
throws NoConnectException, ConnectionSetupException
{
if (connected)
throw new ConnectionSetupException("already connected");
ConnectionDescriptor desc;
try {
desc = new ConnectionDescriptor(connectionDescription);
} catch (com.sun.star.lang.IllegalArgumentException e) {
throw new ConnectionSetupException(e);
}
if (desc.getHost() == null)
throw new ConnectionSetupException("host parameter missing");
// Try all (IPv4 and IPv6) addresses, in case this client is on a
// dual-stack host and the server process is an IPv4-only process, also
// on a dual-stack host (see Stevens, Fenner, Rudoff: "Unix Network
// Programming, Volume 1: The Sockets Networking API, 3rd Edition",
// p. 359):
InetAddress[] adr;
try {
adr = InetAddress.getAllByName(desc.getHost());
} catch (UnknownHostException e) {
throw new ConnectionSetupException(e);
}
Socket socket = null;
boolean isLoopbackAddress = false;
for (int i = 0; i < adr.length; ++i) {
try {
isLoopbackAddress = adr[i].isLoopbackAddress();
socket = new Socket(adr[i], desc.getPort());
break;
} catch (IOException e) {
if (i == adr.length - 1)
throw new NoConnectException(e);
}
}
if (socket == null)
throw new ConnectionSetupException("no socket");
XConnection con;
try {
// we enable tcpNoDelay for loopback connections because
// it can make a significant speed difference on linux boxes.
if (desc.getTcpNoDelay() != null)
socket.setTcpNoDelay(desc.getTcpNoDelay().booleanValue());
else if (isLoopbackAddress)
socket.setTcpNoDelay(true);
con = new SocketConnection(connectionDescription, socket);
} catch (IOException e) {
try {
socket.close();
} catch(IOException ioException) {
}
throw new NoConnectException(e);
}
connected = true;
return con;
}
private boolean connected = false;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */