qadevOOo/tests/java/ifc/loader/_XImplementationLoader.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: _XImplementationLoader.java,v $
  10  * $Revision: 1.6 $
  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 ifc.loader;
  32
  33 import lib.MultiMethodTest;
  34 import lib.StatusException;
  35 import util.RegistryTools;
  36
  37 import com.sun.star.lang.XMultiServiceFactory;
  38 import com.sun.star.lang.XServiceInfo;
  39 import com.sun.star.loader.CannotActivateFactoryException;
  40 import com.sun.star.loader.XImplementationLoader;
  41 import com.sun.star.registry.CannotRegisterImplementationException;
  42 import com.sun.star.registry.XRegistryKey;
  43 import com.sun.star.registry.XSimpleRegistry;
  44 import com.sun.star.uno.UnoRuntime;
  45 import com.sun.star.uno.XInterface;
  46
  47 /**
  48  * Testing <code>com.sun.star.loader.XImplementationLoader</code>
  49  * interface methods :
  50  * <ul>
  51  *  <li><code> activate()</code></li>
  52  *  <li><code> writeRegistryInfo()</code></li>
  53  * </ul> <p>
  54  *
  55  * The following object relations required :
  56  * <ul>
  57  *  <li> <code>'ImplementationLoader'</code> : service which is
  58  *    responsible for loading implementations. </li>
  59  *  <li> <code>'ImplementationUrl'</code> : implementation file location. </li>
  60  *  <li> <code>'ImplementationName'</code> : Name of the implementation.</li>
  61  * </ul> <p>
  62  * Object has to be recreated after this test. <p>
  63  * Test is <b> Not </b> multithread compilant.
  64  */
  65 public class _XImplementationLoader extends MultiMethodTest {
  66
  67     public XImplementationLoader oObj = null;
  68     private String implLoader = null ;
  69     private String implUrl = null ;
  70     private String implName = null ;
  71
  72     /**
  73     * Retrieves object relations.
  74     * @throws StatusException If one of relations not found.
  75     */
  76     public void before() {
  77         implLoader = (String) tEnv.getObjRelation("ImplementationLoader") ;
  78         implUrl = (String) tEnv.getObjRelation("ImplementationUrl") ;
  79         implName = (String) tEnv.getObjRelation("ImplementationName") ;
  80
  81         if (implLoader == null || implUrl == null || implName == null)
  82             throw new StatusException("One of object relations not found",
  83                 new NullPointerException()) ;
  84     }
  85
  86     /**
  87     * First registry file created, and the root key retrieved.
  88     * Then method <code>writeRegistryInfo</code> called and it must
  89     * write some info into the registry root key. After all registry
  90     * is destroyed.<p>
  91     * Has OK status if some info was written into registry.
  92     */
  93     public void _writeRegistryInfo() {
  94         XRegistryKey key ;
  95         XSimpleRegistry xReg = null ;
  96
  97         String tmpDir = util.utils.getOfficeTempDir((XMultiServiceFactory)tParam.getMSF());
  98
  99         try {
 100             xReg = RegistryTools.createRegistryService
 101                 ((XMultiServiceFactory)tParam.getMSF()) ;
 102
 103             xReg.open(tmpDir + "XImpLoader_tmp.rdb", false, true) ;
 104
 105             key = xReg.getRootKey() ;
 106         } catch (com.sun.star.uno.Exception e) {
 107             log.println("Can not create registry for writing") ;
 108             e.printStackTrace(log) ;
 109             tRes.tested("writeRegistryInfo()", false) ;
 110             return ;
 111         }
 112
 113         boolean rc ;
 114         try {
 115             rc = oObj.writeRegistryInfo(key, implLoader, implUrl) ;
 116         } catch (CannotRegisterImplementationException e) {
 117             throw new StatusException("Can not register implementation", e) ;
 118         }
 119
 120         if (rc == false)
 121             log.println("Method returned false value") ;
 122
 123         String[] keys ;
 124         try {
 125             keys = key.getKeyNames() ;
 126         } catch (com.sun.star.uno.Exception e) {
 127             log.println("Error retrieving key names from registry") ;
 128             tRes.tested("writeRegistryInfo()", false) ;
 129             return ;
 130         }
 131
 132         // destroying registry file
 133         try {
 134             xReg.close() ;
 135             xReg.destroy() ;
 136         } catch (com.sun.star.registry.InvalidRegistryException e) {
 137             log.println("Can't destroy registry file.") ;
 138         }
 139
 140         tRes.tested("writeRegistryInfo()", rc && keys.length > 0) ;
 141     }
 142
 143     /**
 144     * Tries to activate the implementation. <p>
 145     *
 146     * Has OK status if not <code>null</code> value returned by method,
 147     * if its implementation name is the same as expected.
 148     */
 149     public void _activate() {
 150         boolean ok = true ;
 151         XInterface factory = null ;
 152
 153         try {
 154             factory = (XInterface) oObj.activate
 155                 (implName, implLoader, implUrl, null) ;
 156         } catch (CannotActivateFactoryException e) {
 157             throw new StatusException("Can not activate factory", e) ;
 158         }
 159
 160         XServiceInfo xServInf = (XServiceInfo) UnoRuntime.queryInterface
 161             (XServiceInfo.class, factory) ;
 162
 163         if (xServInf == null) {
 164             if (factory == null) {
 165                 log.println("activate() returns null - FAILED.");
 166             } else {
 167                 log.println("Activated impementation doesn't support "+
 168                     "XServiceInfo - FAILED.");
 169             }
 170             ok = false ;
 171         } else {
 172             String gImpName = xServInf.getImplementationName() ;
 173             log.println("Implementation name returned :" + gImpName);
 174
 175             if (!gImpName.equals(implName)) {
 176                 log.println("!!! But other name was expected :" + implName);
 177                 ok = false ;
 178             }
 179         }
 180
 181         tRes.tested("activate()", ok) ;
 182     }
 183
 184     /**
 185     * Forces object recreation.
 186     */
 187     public void after() {
 188         this.disposeEnvironment() ;
 189     }
 190 }
 191