toolkit/test/accessibility/OfficeConnection.java

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 // base classes
  20 import com.sun.star.uno.UnoRuntime;
  21
  22 import com.sun.star.bridge.XUnoUrlResolver;
  23 import com.sun.star.lang.XMultiServiceFactory;
  24
  25
  26 /** @descr  This class establishes a connection to a LibreOffice application.
  27  */
  28 public class OfficeConnection
  29 {
  30     public OfficeConnection (int nPortNumber)
  31     {
  32         mnDefaultPort = nPortNumber;
  33         connect ();
  34     }
  35
  36     /** @descr Return the service manager that represents the connected
  37                 LibreOffice application
  38     */
  39     public XMultiServiceFactory getServiceManager ()
  40     {
  41         if ( ! mbInitialized)
  42             connect ();
  43         return maServiceManager;
  44     }
  45
  46     /** @descr  Return a flag that indicates if the constructor has been able to
  47                 establish a valid connection.
  48     */
  49     public boolean connectionIsValid ()
  50     {
  51         return getServiceManager() != null;
  52     }
  53
  54     /** @descr  Connect to an already running LibreOffice application.
  55     */
  56     private void connect ()
  57     {
  58         connect (msDefaultHost, mnDefaultPort);
  59     }
  60
  61     private void connect (String hostname)
  62     {
  63         connect (hostname, mnDefaultPort);
  64     }
  65
  66     /** @descr  Connect to a already running LibreOffice application that has
  67                 been started with a command line argument like
  68                 "--accept=socket,host=localhost,port=5678;urp;"
  69                 */
  70     private void connect (String hostname, int portnumber)
  71     {
  72         mbInitialized = true;
  73         //  Set up connection string.
  74         String sConnectString = "uno:socket,host=" + hostname + ",port=" + portnumber
  75             + ";urp;StarOffice.ServiceManager";
  76
  77
  78         // connect to a running office and get the ServiceManager
  79         try
  80         {
  81             //  Create a URL Resolver.
  82             XMultiServiceFactory aLocalServiceManager =
  83                 com.sun.star.comp.helper.Bootstrap.createSimpleServiceManager();
  84             XUnoUrlResolver aURLResolver = UnoRuntime.queryInterface (
  85                 XUnoUrlResolver.class,
  86                 aLocalServiceManager.createInstance ("com.sun.star.bridge.UnoUrlResolver")
  87                 );
  88
  89             maServiceManager = UnoRuntime.queryInterface (
  90                     XMultiServiceFactory.class,
  91                     aURLResolver.resolve (sConnectString)
  92                     );
  93         }
  94
  95         catch (Exception e)
  96         {
  97             MessageArea.println ("Could not connect with " + sConnectString + " : " + e);
  98             MessageArea.println ("Please start LibreOffice with "
  99                 + "\"--accept=socket,host=localhost,port=5678;urp;\"");
 100         }
 101     }
 102
 103     private int mnDefaultPort = 5678;
 104     private final String msDefaultHost = "localhost";
 105     private XMultiServiceFactory  maServiceManager = null;
 106
 107     /** A value of true just indicates that it has been tried to establish a connection,
 108         not that that has been successful.
 109     */
 110     private boolean mbInitialized = false;
 111 }