jurt/com/sun/star/comp/connections/Acceptor.java

   1 /* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 package com.sun.star.comp.connections;
  21
  22 import com.sun.star.comp.loader.FactoryHelper;
  23 import com.sun.star.connection.AlreadyAcceptingException;
  24 import com.sun.star.connection.ConnectionSetupException;
  25 import com.sun.star.connection.XAcceptor;
  26 import com.sun.star.connection.XConnection;
  27 import com.sun.star.lang.XMultiServiceFactory;
  28 import com.sun.star.lang.XSingleServiceFactory;
  29 import com.sun.star.registry.XRegistryKey;
  30
  31 /**
  32  * A component that implements the <code>XAcceptor</code> interface.
  33  *
  34  * <p>The <code>Acceptor</code> is a general component, that uses less general
  35  * components (like <code>com.sun.star.connection.socketAcceptor</code>) to
  36  * implement its functionality.</p>
  37  *
  38  * @see com.sun.star.connection.XAcceptor
  39  * @see com.sun.star.connection.XConnection
  40  * @see com.sun.star.connection.XConnector
  41  * @see com.sun.star.comp.loader.JavaLoader
  42  *
  43  * @since UDK 1.0
  44  */
  45 public final class Acceptor implements XAcceptor {
  46     /**
  47      * The name of the service.
  48      *
  49      * <p>The <code>JavaLoader</code> accesses this through reflection.</p>
  50      *
  51      * @see com.sun.star.comp.loader.JavaLoader
  52      */
  53     public static final String __serviceName
  54     = "com.sun.star.connection.Acceptor";
  55
  56     /**
  57      * Returns a factory for creating the service.
  58      *
  59      * <p>This method is called by the <code>JavaLoader</code>.</p>
  60      *
  61      * @param implName the name of the implementation for which a service is
  62      *     requested.
  63      * @param multiFactory the service manager to be used (if needed).
  64      * @param regKey the registry key.
  65      * @return an <code>XSingleServiceFactory</code> for creating the component.
  66      *
  67      * @see com.sun.star.comp.loader.JavaLoader
  68      */
  69     public static XSingleServiceFactory __getServiceFactory(
  70         String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)
  71     {
  72         return implName.equals(Acceptor.class.getName())
  73             ? FactoryHelper.getServiceFactory(Acceptor.class, __serviceName,
  74                                               multiFactory, regKey)
  75             : null;
  76     }
  77
  78     /**
  79      * Constructs a new <code>Acceptor</code> that uses the given service
  80      * factory to create a specific <code>XAcceptor</code>.
  81      *
  82      * @param serviceFactory the service factory to use.
  83      */
  84     public Acceptor(XMultiServiceFactory serviceFactory) {
  85         this.serviceFactory = serviceFactory;
  86     }
  87
  88     /**
  89      * Accepts a connection request via the given connection type.
  90      *
  91      * <p>This call blocks until a connection has been established.</p>
  92      *
  93      * <p>The connection description has the following format:
  94      * <code><var>type</var></code><!--
  95      *     -->*(<code><var>key</var>=<var>value</var></code>).
  96      * The specific <code>XAcceptor</code> implementation is instantiated
  97      * through the service factory as
  98      * <code>com.sun.star.connection.<var>type</var>Acceptor</code> (with
  99      * <code><var>type</var></code> in lower case).</p>
 100      *
 101      * @param connectionDescription the description of the connection.
 102      * @return an <code>XConnection</code> to the client.
 103      *
 104      * @see com.sun.star.connection.XConnection
 105      * @see com.sun.star.connection.XConnector
 106      */
 107     public XConnection accept(String connectionDescription) throws
 108         AlreadyAcceptingException, ConnectionSetupException,
 109         com.sun.star.lang.IllegalArgumentException
 110     {
 111         if (DEBUG) {
 112             System.err.println("##### " + getClass().getName() + ".accept("
 113                                + connectionDescription + ")");
 114         }
 115         XAcceptor acc;
 116         synchronized (this) {
 117             if (acceptor == null) {
 118                 acceptor = (XAcceptor) Implementation.getConnectionService(
 119                     serviceFactory, connectionDescription, XAcceptor.class,
 120                     "Acceptor");
 121                 acceptingDescription = connectionDescription;
 122             } else if (!connectionDescription.equals(acceptingDescription)) {
 123                 throw new AlreadyAcceptingException(acceptingDescription
 124                                                     + " vs. "
 125                                                     + connectionDescription);
 126             }
 127             acc = acceptor;
 128         }
 129         return acc.accept(connectionDescription);
 130     }
 131
 132     /**
 133      *
 134      * @see com.sun.star.connection.XAcceptor#stopAccepting
 135      */
 136     public void stopAccepting() {
 137         XAcceptor acc;
 138         synchronized (this) {
 139             acc = acceptor;
 140         }
 141         acc.stopAccepting();
 142     }
 143
 144     private static final boolean DEBUG = false;
 145
 146     private final XMultiServiceFactory serviceFactory;
 147
 148     private XAcceptor acceptor = null;
 149     private String acceptingDescription;
 150 }
 151
 152 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */