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