desktop/test/deployment/locationtest/LocationTest.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.smoketest;
  19
  20 import com.sun.star.lib.uno.helper.Factory;
  21 import com.sun.star.lang.XMultiComponentFactory;
  22 import com.sun.star.lang.XSingleComponentFactory;
  23 import com.sun.star.lib.uno.helper.WeakBase;
  24 import com.sun.star.uno.UnoRuntime;
  25 import com.sun.star.uno.XComponentContext;
  26 import com.sun.star.registry.XRegistryKey;
  27 import com.sun.star.lang.XInitialization;
  28 import com.sun.star.lang.XTypeProvider;
  29 import com.sun.star.lang.XServiceInfo;
  30 import com.sun.star.uno.Type;
  31
  32 /** This class capsulates the class, that implements the minimal component, a
  33  * factory for creating the service (<CODE>__getComponentFactory</CODE>) and a
  34  * method, that writes the information into the given registry key
  35  * (<CODE>__writeRegistryServiceInfo</CODE>).
  36  */
  37 public class LocationTest {
  38     /** This class implements the component. At least the interfaces XServiceInfo,
  39      * XTypeProvider, and XInitialization should be provided by the service.
  40      */
  41     public static class _LocationTest extends WeakBase
  42         implements XServiceInfo {
  43         /** The service name, that must be used to get an instance of this service.
  44          */
  45         private static final String __serviceName =
  46         "com.sun.star.comp.smoketest.LocationTest";
  47
  48         /** The initial component contextr, that gives access to
  49          * the service manager, supported singletons, ...
  50          * It's often later used
  51          */
  52         private XComponentContext m_cmpCtx;
  53
  54         /** The service manager, that gives access to all registered services.
  55          * It's often later used
  56          */
  57         private XMultiComponentFactory m_xMCF;
  58
  59         /** The constructor of the inner class has a XMultiServiceFactory parameter.
  60          * @param xmultiservicefactoryInitialization A special service factory
  61          * could be introduced while initializing.
  62          */
  63         public _LocationTest(XComponentContext xCompContext) {
  64             try {
  65                 m_cmpCtx = xCompContext;
  66                 m_xMCF = m_cmpCtx.getServiceManager();
  67             }
  68             catch( Exception e ) {
  69                 e.printStackTrace();
  70             }
  71         }
  72
  73         /** This method returns an array of all supported service names.
  74          * @return Array of supported service names.
  75          */
  76         public String[] getSupportedServiceNames() {
  77             return getServiceNames();
  78         }
  79
  80         /** This method is a simple helper function to used in the
  81          * static component initialisation functions as well as in
  82          * getSupportedServiceNames.
  83          */
  84         public static String[] getServiceNames() {
  85             String[] sSupportedServiceNames = { __serviceName };
  86             return sSupportedServiceNames;
  87         }
  88
  89         /** This method returns true, if the given service will be
  90          * supported by the component.
  91          * @param sServiceName Service name.
  92          * @return True, if the given service name will be supported.
  93          */
  94         public boolean supportsService( String sServiceName ) {
  95             return sServiceName.equals( __serviceName );
  96         }
  97
  98         /** Return the class name of the component.
  99          * @return Class name of the component.
 100          */
 101         public String getImplementationName() {
 102             return  _LocationTest.class.getName();
 103         }
 104     }
 105
 106
 107     /**
 108      * Gives a factory for creating the service.
 109      * This method is called by the <code>JavaLoader</code>
 110      * <p>
 111      * @return  returns a <code>XSingleComponentFactory</code> for creating
 112      *          the component
 113      * @param   sImplName the name of the implementation for which a
 114      *          service is desired
 115      * @see     com.sun.star.comp.loader.JavaLoader
 116      */
 117     public static XSingleComponentFactory __getComponentFactory(String sImplName)
 118     {
 119         XSingleComponentFactory xFactory = null;
 120
 121         if ( sImplName.equals( _LocationTest.class.getName() ) )
 122             xFactory = Factory.createComponentFactory(_LocationTest.class,
 123                                              _LocationTest.getServiceNames());
 124
 125         return xFactory;
 126     }
 127
 128     /**
 129      * Writes the service information into the given registry key.
 130      * This method is called by the <code>JavaLoader</code>
 131      * <p>
 132      * @return  returns true if the operation succeeded
 133      * @param   regKey the registryKey
 134      * @see     com.sun.star.comp.loader.JavaLoader
 135      */
 136     public static boolean __writeRegistryServiceInfo(XRegistryKey regKey) {
 137         return Factory.writeRegistryServiceInfo(_LocationTest.class.getName(),
 138                                                 _LocationTest.getServiceNames(),
 139                                                 regKey);
 140     }
 141
 142     /** This method is a member of the interface for initializing an object
 143      * directly after its creation.
 144      * @param object This array of arbitrary objects will be passed to the
 145      * component after its creation.
 146      * @throws Exception Every exception will not be handled, but will be
 147      * passed to the caller.
 148      */
 149     public void initialize( Object[] object )
 150         throws com.sun.star.uno.Exception {
 151         /* The component describes what arguments are expected and in which
 152          * order! At this point you can read the objects and initialize
 153          * your component using these objects.
 154          */
 155     }
 156 }