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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Acceptor.java,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 package com.sun.star.comp.connections;
  32
  33 import com.sun.star.comp.loader.FactoryHelper;
  34 import com.sun.star.connection.AlreadyAcceptingException;
  35 import com.sun.star.connection.ConnectionSetupException;
  36 import com.sun.star.connection.XAcceptor;
  37 import com.sun.star.connection.XConnection;
  38 import com.sun.star.lang.XMultiServiceFactory;
  39 import com.sun.star.lang.XSingleServiceFactory;
  40 import com.sun.star.registry.XRegistryKey;
  41
  42 /**
  43  * A component that implements the <code>XAcceptor</code> interface.
  44  *
  45  * <p>The <code>Acceptor</code> is a general component, that uses less general
  46  * components (like <code>com.sun.star.connection.socketAcceptor</code>) to
  47  * implement its functionality.</p>
  48  *
  49  * @see com.sun.star.connections.XAcceptor
  50  * @see com.sun.star.connections.XConnection
  51  * @see com.sun.star.connections.XConnector
  52  * @see com.sun.star.loader.JavaLoader
  53  *
  54  * @since UDK 1.0
  55  */
  56 public final class Acceptor implements XAcceptor {
  57     /**
  58      * The name of the service.
  59      *
  60      * <p>The <code>JavaLoader</code> acceses this through reflection.</p>
  61      *
  62      * @see com.sun.star.comp.loader.JavaLoader
  63      */
  64     public static final String __serviceName
  65     = "com.sun.star.connection.Acceptor";
  66
  67     /**
  68      * Returns a factory for creating the service.
  69      *
  70      * <p>This method is called by the <code>JavaLoader</code>.</p>
  71      *
  72      * @param implName the name of the implementation for which a service is
  73      *     requested.
  74      * @param multiFactory the service manager to be used (if needed).
  75      * @param regKey the registry key.
  76      * @return an <code>XSingleServiceFactory</code> for creating the component.
  77      *
  78      * @see com.sun.star.comp.loader.JavaLoader
  79      */
  80     public static XSingleServiceFactory __getServiceFactory(
  81         String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey)
  82     {
  83         return implName.equals(Acceptor.class.getName())
  84             ? FactoryHelper.getServiceFactory(Acceptor.class, __serviceName,
  85                                               multiFactory, regKey)
  86             : null;
  87     }
  88
  89     /**
  90      * Writes the service information into the given registry key.
  91      *
  92      * <p>This method is called by the <code>JavaLoader</code>.</p>
  93      *
  94      * @param regKey the registry key.
  95      * @return <code>true</code> if the operation succeeded.
  96      *
  97      * @see com.sun.star.comp.loader.JavaLoader
  98      */
  99     public static boolean __writeRegistryServiceInfo(XRegistryKey regKey) {
 100         return FactoryHelper.writeRegistryServiceInfo(Acceptor.class.getName(),
 101                                                       __serviceName, regKey);
 102     }
 103
 104     /**
 105      * Constructs a new <code>Acceptor</code> that uses the given service
 106      * factory to create a specific <code>XAcceptor</code>.
 107      *
 108      * @param serviceFactory the service factory to use.
 109      */
 110     public Acceptor(XMultiServiceFactory serviceFactory) {
 111         this.serviceFactory = serviceFactory;
 112     }
 113
 114     /**
 115      * Accepts a connection request via the given connection type.
 116      *
 117      * <p>This call blocks until a connection has been established.</p>
 118      *
 119      * <p>The connection description has the following format:
 120      * <code><var>type</var></code><!--
 121      *     -->*(<code><var>key</var>=<var>value</var></code>).
 122      * The specific <code>XAcceptor</code> implementation is instantiated
 123      * through the service factory as
 124      * <code>com.sun.star.connection.<var>type</var>Acceptor</code> (with
 125      * <code><var>type</var></code> in lower case).</p>
 126      *
 127      * @param connectionDescription the description of the connection.
 128      * @return an <code>XConnection</code> to the client.
 129      *
 130      * @see com.sun.star.connections.XConnection
 131      * @see com.sun.star.connections.XConnector
 132      */
 133     public XConnection accept(String connectionDescription) throws
 134         AlreadyAcceptingException, ConnectionSetupException,
 135         com.sun.star.lang.IllegalArgumentException
 136     {
 137         if (DEBUG) {
 138             System.err.println("##### " + getClass().getName() + ".accept("
 139                                + connectionDescription + ")");
 140         }
 141         XAcceptor acc;
 142         synchronized (this) {
 143             if (acceptor == null) {
 144                 acceptor = (XAcceptor) Implementation.getConnectionService(
 145                     serviceFactory, connectionDescription, XAcceptor.class,
 146                     "Acceptor");
 147                 acceptingDescription = connectionDescription;
 148             } else if (!connectionDescription.equals(acceptingDescription)) {
 149                 throw new AlreadyAcceptingException(acceptingDescription
 150                                                     + " vs. "
 151                                                     + connectionDescription);
 152             }
 153             acc = acceptor;
 154         }
 155         return acc.accept(connectionDescription);
 156     }
 157
 158     // see com.sun.star.connection.XAcceptor#stopAccepting
 159     public void stopAccepting() {
 160         XAcceptor acc;
 161         synchronized (this) {
 162             acc = acceptor;
 163         }
 164         acc.stopAccepting();
 165     }
 166
 167     private static final boolean DEBUG = false;
 168
 169     private final XMultiServiceFactory serviceFactory;
 170
 171     private XAcceptor acceptor = null;
 172     private String acceptingDescription;
 173 }