ridljar/com/sun/star/comp/helper/ComponentContext.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 package com.sun.star.comp.helper;
  19
  20 import com.sun.star.uno.UnoRuntime;
  21 import com.sun.star.uno.Any;
  22
  23 import com.sun.star.uno.DeploymentException;
  24 import com.sun.star.uno.XComponentContext;
  25 import com.sun.star.lang.XMultiComponentFactory;
  26 import com.sun.star.lang.XSingleComponentFactory;
  27 import com.sun.star.lang.XComponent;
  28 import com.sun.star.lang.XEventListener;
  29 import com.sun.star.lang.EventObject;
  30
  31 import java.util.ArrayList;
  32 import java.util.Hashtable;
  33 import java.util.Map;
  34
  35
  36
  37 class Disposer implements XEventListener
  38 {
  39     private final XComponent m_xComp;
  40
  41
  42     Disposer( XComponent xComp )
  43     {
  44         m_xComp = xComp;
  45     }
  46
  47     public void disposing( EventObject Source )
  48     {
  49         m_xComp.dispose();
  50     }
  51 }
  52
  53 /** Component context implementation.
  54 */
  55 public class ComponentContext implements XComponentContext, XComponent
  56 {
  57     private static final boolean DEBUG = false;
  58     private static final String SMGR_NAME = "/singletons/com.sun.star.lang.theServiceManager";
  59     private static final String TDMGR_NAME = "/singletons/com.sun.star.reflection.theTypeDescriptionManager";
  60
  61     private Map<String,Object> m_table;
  62     private XComponentContext m_xDelegate;
  63
  64     private XMultiComponentFactory m_xSMgr;
  65     private boolean m_bDisposeSMgr;
  66
  67     private ArrayList<XEventListener> m_eventListener;
  68
  69     public ComponentContext( Hashtable<String,Object> table, XComponentContext xDelegate )
  70     {
  71         this((Map<String,Object>) table, xDelegate);
  72     }
  73
  74     /** Ctor to create a component context passing a hashtable for values and a delegator
  75         reference. Entries of the passed hashtable are either direct values or
  76         ComponentContextEntry objects.
  77
  78         @param table
  79                entries
  80         @param xDelegate
  81                if values are not found, request is delegated to this object
  82     */
  83     public ComponentContext( Map<String,Object> table, XComponentContext xDelegate )
  84     {
  85         m_eventListener = new ArrayList<XEventListener>();
  86         m_table = table;
  87         m_xDelegate = xDelegate;
  88         m_xSMgr = null;
  89         m_bDisposeSMgr = false;
  90
  91         Object o = table.get( SMGR_NAME );
  92         if (o != null)
  93         {
  94             if (o instanceof ComponentContextEntry)
  95             {
  96                 o = ((ComponentContextEntry)o).m_value;
  97             }
  98             m_xSMgr = UnoRuntime.queryInterface(
  99                 XMultiComponentFactory.class, o );
 100         }
 101         if (m_xSMgr != null)
 102         {
 103             m_bDisposeSMgr = true;
 104         }
 105         else if (m_xDelegate != null)
 106         {
 107             m_xSMgr = m_xDelegate.getServiceManager();
 108         }
 109
 110         // listen for delegate
 111         XComponent xComp = UnoRuntime.queryInterface(
 112             XComponent.class, m_xDelegate );
 113         if (xComp != null)
 114         {
 115             xComp.addEventListener( new Disposer( this ) );
 116         }
 117     }
 118
 119     // XComponentContext impl
 120
 121     public Object getValueByName( String rName )
 122     {
 123         Object o = m_table.get( rName );
 124         if (o == null)
 125         {
 126             if (m_xDelegate != null)
 127             {
 128                 return m_xDelegate.getValueByName( rName );
 129             }
 130             else
 131             {
 132                 return Any.VOID;
 133             }
 134         }
 135
 136         if (!(o instanceof ComponentContextEntry))
 137         {
 138             // direct value in map
 139             return o;
 140         }
 141
 142         ComponentContextEntry entry = (ComponentContextEntry)o;
 143         if (entry.m_lateInit == null)
 144         {
 145             return entry.m_value;
 146         }
 147
 148         Object xInstance = null;
 149         try
 150         {
 151             String serviceName = (String)entry.m_lateInit;
 152             if (serviceName != null)
 153             {
 154                 if (m_xSMgr != null)
 155                 {
 156                     xInstance = m_xSMgr.createInstanceWithContext( serviceName, this );
 157                 }
 158                 else
 159                 {
 160                     if (DEBUG)
 161                         System.err.println( "### no service manager instance for late init of singleton instance \"" + rName + "\"!" );
 162                 }
 163             }
 164             else
 165             {
 166                 XSingleComponentFactory xCompFac = UnoRuntime.queryInterface( XSingleComponentFactory.class, entry.m_lateInit );
 167                 if (xCompFac != null)
 168                 {
 169                     xInstance = xCompFac.createInstanceWithContext( this );
 170                 }
 171                 else
 172                 {
 173                     if (DEBUG)
 174                         System.err.println( "### neither service name nor service factory given for late init of singleton instance \"" + rName + "\"!" );
 175                 }
 176             }
 177         }
 178         catch (com.sun.star.uno.Exception exc)
 179         {
 180             if (DEBUG)
 181                 System.err.println( "### exception occurred on late init of singleton instance \"" + rName + "\": " + exc.getMessage() );
 182         }
 183
 184         if (xInstance != null)
 185         {
 186             synchronized (entry)
 187             {
 188                 if (entry.m_lateInit != null)
 189                 {
 190                     entry.m_value = xInstance;
 191                     entry.m_lateInit = null;
 192                 }
 193                 else // inited in the meantime
 194                 {
 195                     // dispose fresh service instance
 196                     XComponent xComp = UnoRuntime.queryInterface(
 197                         XComponent.class, xInstance );
 198                     if (xComp != null)
 199                     {
 200                         xComp.dispose();
 201                     }
 202                 }
 203             }
 204         }
 205         else
 206         {
 207             if (DEBUG)
 208                 System.err.println( "### failed late init of singleton instance \"" + rName + "\"!" );
 209         }
 210         return entry.m_value;
 211     }
 212
 213     public XMultiComponentFactory getServiceManager()
 214     {
 215         if (m_xSMgr == null)
 216         {
 217             throw new DeploymentException(
 218                 "null component context service manager" );
 219         }
 220         return m_xSMgr;
 221     }
 222
 223     // XComponent impl
 224
 225     public void dispose()
 226     {
 227         if (DEBUG)
 228             System.err.print( "> disposing context " + this );
 229
 230         // fire events
 231         EventObject evt = new EventObject( this );
 232         for (XEventListener listener : m_eventListener)
 233         {
 234             listener.disposing( evt );
 235         }
 236         m_eventListener.clear();
 237
 238         XComponent tdmgr = null;
 239         // dispose values, then service manager, then typedescription manager
 240         for (Map.Entry<String, Object> entry : m_table.entrySet())
 241         {
 242             String name = entry.getKey();
 243             if (! name.equals( SMGR_NAME ))
 244             {
 245                 Object o = entry.getValue();
 246                 if (o instanceof ComponentContextEntry)
 247                 {
 248                     o = ((ComponentContextEntry)o).m_value;
 249                 }
 250
 251                 XComponent xComp = UnoRuntime.queryInterface( XComponent.class, o );
 252                 if (xComp != null)
 253                 {
 254                     if (name.equals( TDMGR_NAME ))
 255                     {
 256                         tdmgr = xComp;
 257                     }
 258                     else
 259                     {
 260                         xComp.dispose();
 261                     }
 262                 }
 263             }
 264         }
 265         m_table.clear();
 266
 267         // smgr
 268         if (m_bDisposeSMgr)
 269         {
 270             XComponent xComp = UnoRuntime.queryInterface(
 271                 XComponent.class, m_xSMgr );
 272             if (xComp != null)
 273             {
 274                 xComp.dispose();
 275             }
 276         }
 277         m_xSMgr = null;
 278
 279         // tdmgr
 280         if (tdmgr != null)
 281         {
 282             tdmgr.dispose();
 283         }
 284
 285         if (DEBUG)
 286             System.err.println( "... finished" );
 287     }
 288
 289     public void addEventListener( XEventListener xListener )
 290     {
 291         if (xListener == null)
 292             throw new com.sun.star.uno.RuntimeException( "Listener must not be null" );
 293           if (m_eventListener.contains( xListener ))
 294               throw new com.sun.star.uno.RuntimeException( "Listener already registered." );
 295
 296            m_eventListener.add( xListener );
 297     }
 298
 299     public void removeEventListener( XEventListener xListener )
 300     {
 301         if (xListener == null)
 302             throw new com.sun.star.uno.RuntimeException( "Listener must not be null" );
 303           if (! m_eventListener.contains( xListener ))
 304               throw new com.sun.star.uno.RuntimeException( "Listener is not registered." );
 305
 306         m_eventListener.remove( xListener );
 307     }
 308 }