| /************************************************************** |
| * |
| * 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 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| 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; |
| |
| /** |
| * 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; |
| } |
| |
| /** |
| * 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; |
| } |