odk/examples/DevelopersGuide/OfficeDev/DesktopEnvironment/OfficeConnect.java

   1 /* -*- Mode: Java; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  the BSD license.
   6  *
   7  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *  1. Redistributions of source code must retain the above copyright
  14  *     notice, this list of conditions and the following disclaimer.
  15  *  2. Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in the
  17  *     documentation and/or other materials provided with the distribution.
  18  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  31  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  32  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *************************************************************************/
  35
  36
  37
  38
  39 // __________ Implementation __________
  40
  41 /**
  42  * support ONE singleton uno connection to a running office installation!
  43  * Can be used to open/use/close connection to uno environment of an office. If
  44  * necessary a new office instance is started.
  45  * ctor isn't available from outside. You should call static function
  46  * "getConnection()" to open or use internal set connection which is created one
  47  * times only.
  48  *
  49  */
  50 public class OfficeConnect
  51 {
  52
  53
  54     /**
  55      * At first call we create static connection object and open connection to an
  56      * office - a new office instance is started if necessary
  57      * Then - and for all further requests we return these static connection member.
  58      */
  59     public static synchronized void createConnection()
  60     {
  61         if (maConnection == null)
  62             maConnection = new OfficeConnect();
  63     }
  64
  65
  66
  67
  68
  69
  70
  71     /**
  72      * ctor
  73      * We try to open the connection in our ctor ... transparently for user.
  74      * After it was successful you will find an internal set member
  75      * m_xRemoteContext which means remote component context of the connected office.
  76      * The context can be used to get the remote service manager from the office.
  77      * We made it private to support singleton pattern of these implementation.
  78      * see getConnection() for further information
  79      */
  80     private OfficeConnect()
  81     {
  82         try
  83         {
  84             // get the remote office context. If necessary a new office
  85             // process is started
  86             mxOfficeContext = com.sun.star.comp.helper.Bootstrap.bootstrap();
  87             System.out.println("Connected to a running office ...");
  88             mxServiceManager = mxOfficeContext.getServiceManager();
  89         }
  90         catch (java.lang.Exception ex)
  91         {
  92             System.err.println("connection failed" + ex);
  93             ex.printStackTrace(System.err);
  94             System.exit(1);
  95
  96         }
  97     }
  98
  99
 100
 101
 102
 103
 104
 105     /**
 106      * returns remote component context of the connected office
 107      */
 108     public static synchronized com.sun.star.uno.XComponentContext getOfficeContext()
 109     {
 110         return mxOfficeContext;
 111     }
 112
 113
 114
 115     /**
 116      * member
 117      */
 118     // singleton connection instance
 119     private static OfficeConnect maConnection;
 120
 121     // reference to the office component context
 122     private static com.sun.star.uno.XComponentContext  mxOfficeContext;
 123     // reference to remote service manager of singleton connection object
 124     private static com.sun.star.lang.XMultiComponentFactory  mxServiceManager;
 125 }
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */