/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
package com.sun.star.comp.servicemanager;
import com.sun.star.uno.UnoRuntime;
import com.sun.star.uno.XComponentContext;
import com.sun.star.container.XSet;
import com.sun.star.container.XContentEnumerationAccess;
import com.sun.star.container.XEnumeration;
import com.sun.star.lang.XComponent;
import com.sun.star.lang.XEventListener;
import com.sun.star.lang.XInitialization;
import com.sun.star.lang.XMultiServiceFactory;
import com.sun.star.lang.XServiceInfo;
import com.sun.star.lang.XSingleServiceFactory;
import com.sun.star.lang.XSingleComponentFactory;
import com.sun.star.lang.XMultiComponentFactory;
import com.sun.star.registry.XRegistryKey;
import com.sun.star.registry.XSimpleRegistry;
import com.sun.star.loader.XImplementationLoader;
import java.lang.reflect.InvocationTargetException;
/**
* The ServiceManager
class is an implmentation of the ServiceManager
the central class needed for
* implementing or using UNO components in Java.
*
* The Methods queryInterface
and isSame
delegate
* calls to the implementing objects and are used instead of casts
* and identity comparisons.
*
* @author Markus Herzog
* @see com.sun.star.lang.XMultiServiceFactory
* @see com.sun.star.container.XSet
* @see com.sun.star.container.XContentEnumerationAccess
* @see com.sun.star.lang.XComponent
* @see com.sun.star.lang.XServiceInfo
* @see com.sun.star.lang.XInitialization
* @since UDK1.0
*/
public class ServiceManager implements XMultiServiceFactory,
XMultiComponentFactory,
XSet,
XContentEnumerationAccess,
XComponent,
XServiceInfo,
XInitialization
{
private static final boolean DEBUG = false;
private static final void DEBUG (String dbg) {
if (DEBUG) System.err.println( dbg );
}
private static com.sun.star.uno.Type UNO_TYPE = null;
XImplementationLoader loader = null;
static String[] supportedServiceNames = {
"com.sun.star.lang.MultiServiceFactory",
"com.sun.star.lang.ServiceManager"
};
java.util.Vector eventListener;
java.util.Hashtable factoriesByImplNames;
java.util.Hashtable factoriesByServiceNames; // keys:
private com.sun.star.uno.XComponentContext m_xDefaultContext;
/**
* Creates a new instance of the ServiceManager
.
*/
public ServiceManager() {
eventListener = new java.util.Vector();
factoriesByImplNames = new java.util.Hashtable();
factoriesByServiceNames = new java.util.Hashtable();
m_xDefaultContext = null;
}
/**
* Creates a new instance of the ServiceManager
.
*/
public ServiceManager( XComponentContext xContext ) {
eventListener = new java.util.Vector();
factoriesByImplNames = new java.util.Hashtable();
factoriesByServiceNames = new java.util.Hashtable();
m_xDefaultContext = xContext;
}
/**
* Returns the service factory for the ServiceManager
. If the given implementation name
* does not equal to the ServiceManagers
class name null will be returned.
*
* @return the factory for the ServiceManager
.
* @param implName the implementation name of the of the service.
* Must be equal to com.sun.star.comp.servicemanager.ServicManager
* @param multiFactory refernce of the MultiServiceFactory
. This parameter will be ignored.
* @param regKey the root key of the registry. This parameter will be ignored.
*/
public static XSingleServiceFactory getServiceFactory( String implName,
XMultiServiceFactory multiFactory,
XRegistryKey regKey)
{
if ( implName.equals(ServiceManager.class.getName()) )
return new ServiceManagerFactory();
return null;
}
/**
* Supplies a Java component loader. The loader component must be enlisted at the ServiceManager
before.
*
* @return a new instance of the Java component loader * @see com.sun.star.loader.Java */ private XImplementationLoader getLoader() throws com.sun.star.uno.Exception, com.sun.star.uno.RuntimeException { Object[] param = { this }; DEBUG("make loader"); Object loaderObj = createInstanceWithArgumentsAndContext( "com.sun.star.loader.Java", param, m_xDefaultContext ); if (loaderObj == null) throw new com.sun.star.uno.Exception("Can get an instance of com.sun.star.loader.Java"); return UnoRuntime.queryInterface( XImplementationLoader.class, loaderObj ); } /** * Registers a list of components given by their class names. *
* @param newImpls list of the components that should be registered, given by their class names.
* If any exception occurred during the registration, the process will be canceled.
* @see com.sun.star.container.XSet
*/
private void xaddFactories( String[] newImpls )
throws com.sun.star.uno.Exception
{
for (int i=0; i
* @param args the first argument ( args[0] ) specifices the SimpleRegistry object
* @see com.sun.star.lang.XInitialization
* @see com.sun.star.lang.RegistryServiceManager
* @see com.sun.star.lang.XSimpleRegistry
*/
public void initialize( Object args[] )
throws com.sun.star.uno.Exception,
com.sun.star.uno.RuntimeException {
XSimpleRegistry xSimpleRegistry ;
try {
xSimpleRegistry = (XSimpleRegistry) args[0];
if (xSimpleRegistry != null)
{
XRegistryKey rootkey = xSimpleRegistry.getRootKey();
XRegistryKey implkey_xRegistryKey = rootkey.openKey("Implementations");
if(implkey_xRegistryKey != null) {
XRegistryKey xRegistryKeys[] = implkey_xRegistryKey.openKeys();
for(int i = 0; i < xRegistryKeys.length; ++ i) {
xaddFactories(new String[]{xRegistryKeys[i].getStringValue()});
}
}
}
if (args.length > 1)
{
m_xDefaultContext = (XComponentContext)args[ 1 ];
}
}
catch (ArrayIndexOutOfBoundsException e)
{
throw new com.sun.star.lang.IllegalArgumentException("Argument must not be null.");
}
}
/**
* Creates a new instance of a specified service. Therefor the associated factory of the service is
* looked up and used to instanciate a new component.
*
* @return newly created component
* @param serviceSpecifier indicates the service or component name
* @see com.sun.star.lang.XMultiServiceFactory
*/
public java.lang.Object createInstance( String serviceSpecifier )
throws com.sun.star.uno.Exception,
com.sun.star.uno.RuntimeException
{
return createInstanceWithContext( serviceSpecifier, m_xDefaultContext );
}
/**
* Creates a new instance of a specified service with the given parameters.
* Therefor the associated factory of the service is looked up and used to instanciate a new component.
*
* @return newly created component
* @param serviceSpecifier indicates the service or component name
* @see com.sun.star.lang.XMultiServiceFactory
*/
public java.lang.Object createInstanceWithArguments(
String serviceSpecifier, Object[] args )
throws com.sun.star.uno.Exception, com.sun.star.uno.RuntimeException
{
if (DEBUG) {
System.err.println("createInstanceWithArguments:" );
for (int i=0; i
* @return list of Strings of all service names
* @see com.sun.star.container.XContentEnumerationAccess
*/
public String[] getAvailableServiceNames()
throws com.sun.star.uno.RuntimeException
{
int i = 0;
String[] availableServiceNames = new String[factoriesByServiceNames.size()];
java.util.Enumeration keys = factoriesByServiceNames.keys();
while (keys.hasMoreElements())
availableServiceNames[i++] = (String) keys.nextElement();
return availableServiceNames;
}
// XMultiComponentFactory implementation
/** Create a service instance with given context.
@param rServiceSpecifier service name
@param xContext context
@return service instance
*/
public java.lang.Object createInstanceWithContext(
String rServiceSpecifier,
com.sun.star.uno.XComponentContext xContext )
throws com.sun.star.uno.Exception
{
Object fac = queryServiceFactory( rServiceSpecifier );
if (fac != null)
{
XSingleComponentFactory xCompFac = UnoRuntime.queryInterface(
XSingleComponentFactory.class, fac );
if (xCompFac != null)
{
return xCompFac.createInstanceWithContext( xContext );
}
else
{
XSingleServiceFactory xServiceFac = UnoRuntime.queryInterface(
XSingleServiceFactory.class, fac );
if (xServiceFac != null)
{
if (DEBUG)
System.err.println( "### ignoring context raising service \"" + rServiceSpecifier + "\"!" );
return xServiceFac.createInstance();
}
else
{
throw new com.sun.star.uno.Exception(
"retrieved service factory object for \"" + rServiceSpecifier +
"\" does not export XSingleComponentFactory nor XSingleServiceFactory!" );
}
}
}
return null;
}
/** Create a service instance with given context and arguments.
@param rServiceSpecifier service name
@param rArguments arguments
@param xContext context
@return service instance
*/
public java.lang.Object createInstanceWithArgumentsAndContext(
String rServiceSpecifier,
java.lang.Object[] rArguments,
com.sun.star.uno.XComponentContext xContext )
throws com.sun.star.uno.Exception
{
Object fac = queryServiceFactory( rServiceSpecifier );
if (fac != null)
{
XSingleComponentFactory xCompFac = UnoRuntime.queryInterface(
XSingleComponentFactory.class, fac );
if (xCompFac != null)
{
return xCompFac.createInstanceWithArgumentsAndContext( rArguments, xContext );
}
else
{
XSingleServiceFactory xServiceFac = UnoRuntime.queryInterface(
XSingleServiceFactory.class, fac );
if (xServiceFac != null)
{
if (DEBUG)
System.err.println( "### ignoring context raising service \"" + rServiceSpecifier + "\"!" );
return xServiceFac.createInstanceWithArguments( rArguments );
}
else
{
throw new com.sun.star.uno.Exception(
"retrieved service factory object for \"" + rServiceSpecifier +
"\" does not export XSingleComponentFactory nor XSingleServiceFactory!" );
}
}
}
return null;
}
// public String[] getAvailableServiceNames();
/**
* Removes all listeners from the
* @see com.sun.star.lang.XComponent
*/
public void dispose()
throws com.sun.star.uno.RuntimeException
{
if (eventListener != null) {
java.util.Enumeration enumer = eventListener.elements();
while (enumer.hasMoreElements()) {
XEventListener listener = (XEventListener) enumer.nextElement();
listener.disposing(new com.sun.star.lang.EventObject(this));
}
eventListener.removeAllElements();
}
factoriesByServiceNames.clear();
factoriesByImplNames.clear();
}
/**
* Adds a new
* @param xListener the new listener which should been added.
* @see com.sun.star.lang.XComponent
*/
public void addEventListener( XEventListener xListener )
throws com.sun.star.uno.RuntimeException
{
if (xListener == null)
throw new com.sun.star.uno.RuntimeException("Listener must not be null");
if ( eventListener.contains(xListener) )
throw new com.sun.star.uno.RuntimeException("Listener already registred.");
eventListener.addElement(xListener);
}
/**
* Removes a
* @param xListener the new listener which should been removed.
* @see com.sun.star.lang.XComponent
*/
public void removeEventListener( XEventListener xListener )
throws com.sun.star.uno.RuntimeException
{
if (xListener == null)
throw new com.sun.star.uno.RuntimeException("Listener must not be null");
if ( !eventListener.contains(xListener) )
throw new com.sun.star.uno.RuntimeException("Listener is not registered.");
eventListener.removeElement(xListener);
}
/**
* Checks if a component is registered at the
* @return true if the component is registred otherwise false.
* @param object object which provides a
* @param object factory which should be added.
* @see com.sun.star.container.XSet
* @see com.sun.star.lang.XSingleServiceFactory
*/
public void insert( Object object )
throws com.sun.star.lang.IllegalArgumentException,
com.sun.star.container.ElementExistException,
com.sun.star.uno.RuntimeException
{
if (object == null) throw new com.sun.star.lang.IllegalArgumentException();
XServiceInfo xServiceInfo =
UnoRuntime.queryInterface(XServiceInfo.class, object);
if (xServiceInfo == null)
throw new com.sun.star.lang.IllegalArgumentException(
"The given object does not implement the XServiceInfo interface."
);
if ( factoriesByImplNames.containsKey( xServiceInfo.getImplementationName() ) ) {
throw new com.sun.star.container.ElementExistException(
xServiceInfo.getImplementationName() + " already registred"
);
}
DEBUG("add factory " + object.toString() + " for " + xServiceInfo.getImplementationName());
factoriesByImplNames.put( xServiceInfo.getImplementationName(), object );
String[] serviceNames = xServiceInfo.getSupportedServiceNames();
java.util.Vector vec ;
for (int i=0; i
* @param object factory which should be removed.
* @see com.sun.star.container.XSet
* @see com.sun.star.lang.XSingleServiceFactory
*/
public void remove( Object object )
throws com.sun.star.lang.IllegalArgumentException,
com.sun.star.container.NoSuchElementException,
com.sun.star.uno.RuntimeException
{
if (object == null)
throw new com.sun.star.lang.IllegalArgumentException(
"The given object must not be null."
);
XServiceInfo xServiceInfo =
UnoRuntime.queryInterface(XServiceInfo.class, object);
if (xServiceInfo == null)
throw new com.sun.star.lang.IllegalArgumentException(
"The given object does not implement the XServiceInfo interface."
);
XSingleServiceFactory xSingleServiceFactory =
UnoRuntime.queryInterface(XSingleServiceFactory.class, object);
if (xSingleServiceFactory == null)
throw new com.sun.star.lang.IllegalArgumentException(
"The given object does not implement the XSingleServiceFactory interface."
);
if ( factoriesByImplNames.remove( xServiceInfo.getImplementationName() ) == null )
throw new com.sun.star.container.NoSuchElementException(
xServiceInfo.getImplementationName() +
" is not registered as an implementation."
);
String[] serviceNames = xServiceInfo.getSupportedServiceNames();
for ( int i=0; i
* @return the UNO type of the
* @return true - if the list of the registred components is not empty - otherwise false.
* @see com.sun.star.container.XElementAccess
*/
public boolean hasElements() {
return ! factoriesByImplNames.isEmpty();
}
/**
* Provides an enumeration of of all factorys for a specified service.
*
* @return an enumeration for service name.
* @param serviceName name of the requested service
* @see com.sun.star.container.XContentEnumerationAccess
*/
public XEnumeration createContentEnumeration( String serviceName )
throws com.sun.star.uno.RuntimeException
{
XEnumeration enumer ;
java.util.Vector serviceList = (java.util.Vector) factoriesByServiceNames.get(serviceName);
if (serviceList != null)
enumer = new ServiceEnumerationImpl( serviceList.elements() );
else
enumer = new ServiceEnumerationImpl();
return enumer;
}
/**
* Returns the implementation name of the
* @return the class name of the
* @return true if the service is supported - otherwise false.
* @param serviceName service name which should be checked.
* @see com.sun.star.lang.XServiceInfo
*/
public boolean supportsService( String serviceName )
throws com.sun.star.uno.RuntimeException
{
for (int i=0; i
* @author Markus Herzog
* @see com.sun.star.lang.XSingleServiceFactory
* @see com.sun.star.lang.XServiceInfo
* @since UDK1.0
*/
class ServiceEnumerationImpl implements XEnumeration {
java.util.Enumeration enumeration = null;
/**
* Constructs a new empty instance.
*/
public ServiceEnumerationImpl() {
}
/**
* Constructs a new instance with a given enumeration.
*
* @param enumer is the enumeration which should been wrapped.
* @see com.sun.star.container.XEnumeration
*/
public ServiceEnumerationImpl(java.util.Enumeration enumer) {
enumeration = enumer;
}
/**
* Checks if the enumeration contains more elements.
*
* @return true if more elements are available - otherwise false.
* @see com.sun.star.container.XEnumeration
*/
public boolean hasMoreElements()
throws com.sun.star.uno.RuntimeException
{
return enumeration != null && enumeration.hasMoreElements();
}
/**
* Returns the next element of the enumeration. If no further elements
* available a com.sun.star.container.NoSuchElementException exception will be thrown.
*
* @return the next element.
* @see com.sun.star.container.XEnumeration
*/
public Object nextElement()
throws com.sun.star.container.NoSuchElementException,
com.sun.star.lang.WrappedTargetException,
com.sun.star.uno.RuntimeException
{
if (enumeration == null)
throw new com.sun.star.container.NoSuchElementException();
try {
return enumeration.nextElement();
} catch (java.util.NoSuchElementException e) {
com.sun.star.container.NoSuchElementException ex =
new com.sun.star.container.NoSuchElementException(
e.toString());
ex.initCause(e);
throw ex;
}
}
}
}
/**
* The
* @author Markus Herzog
* @see com.sun.star.lang.XSingleServiceFactory
* @see com.sun.star.lang.XServiceInfo
* @since UDK1.0
*/
class ServiceManagerFactory implements XServiceInfo, XSingleComponentFactory, XSingleServiceFactory
{
/**
* Creates a new instance of the
* @return
* @return true - if the service is supported, otherwise false.
* @param serviceName the name of the service that should be checked.
* @see com.sun.star.lang.XServiceInfo
*/
public boolean supportsService( String serviceName )
throws com.sun.star.uno.RuntimeException
{
for ( int i=0; i
* @return a list aof all supported service names.
* @see com.sun.star.lang.XServiceInfo
*/
public String[] getSupportedServiceNames()
throws com.sun.star.uno.RuntimeException
{
return ServiceManager.supportedServiceNames;
}
/**
* Creates a new instance of the
* @return newly created
* @return null - allways throws an exception
* @param aArguments arguments for new instance.
* @see com.sun.star.lang.XSingleServiceFactory
*/
public java.lang.Object createInstanceWithArguments( java.lang.Object[] aArguments )
throws com.sun.star.uno.Exception,
com.sun.star.uno.RuntimeException
{
throw new com.sun.star.lang.NoSuchMethodException("Constructor with arguments is not supported.");
}
// XSingleComponentFactory impl
//______________________________________________________________________________________________
public Object createInstanceWithContext( XComponentContext xContext )
throws com.sun.star.uno.Exception, com.sun.star.uno.RuntimeException
{
return new ServiceManager( xContext );
}
//______________________________________________________________________________________________
public Object createInstanceWithArgumentsAndContext(
Object aArguments [], XComponentContext xContext )
throws com.sun.star.uno.Exception, com.sun.star.uno.RuntimeException
{
throw new com.sun.star.lang.NoSuchMethodException(
"ServiceManagerFactory.createInstanceWithArgumentsAndContext() not impl!" );
}
}
SimpleRegistry
.
* The components which should be added will be searched under the Implementations key in the registry.
* ServiceManager
and clears the list of the services.
* EventListener
. The listener is notified when a
* service is added (removed) to (from) the ServiceManager
.
* If the listener is already registred a
* com.sun.star.uno.RuntimeException
will be thrown.
* EventListener
from the ServiceManager
.
* If the listener is not registered a com.sun.star.uno.RuntimeException
* will be thrown.
* ServiceManager
. The given object argument must
* provide a XServiceInfo
interface.
* XServiceInfo
interface.
* @see com.sun.star.container.XSet
* @see com.sun.star.lang.XServiceInfo
*/
public boolean has( Object object )
throws com.sun.star.uno.RuntimeException
{
if (object == null)
throw new com.sun.star.uno.RuntimeException("The parameter must not been null");
XServiceInfo xServiceInfo = UnoRuntime.queryInterface(XServiceInfo.class, object);
return xServiceInfo != null && UnoRuntime.areSame(factoriesByImplNames.get(xServiceInfo.getImplementationName()), object);
}
/**
* Adds a SingleServiceFactory
to the ServiceManager
.
* SingleServiceFactory
from the ServiceManager
.
* ServiceManager
* ServiceManager
.
* @see com.sun.star.container.XElementAccess
* @see com.sun.star.uno.TypeClass
*/
public com.sun.star.uno.Type getElementType()
throws com.sun.star.uno.RuntimeException
{
if ( UNO_TYPE == null )
UNO_TYPE = new com.sun.star.uno.Type(ServiceManager.class);
return UNO_TYPE;
}
/**
* Checks if the any componets are registered.
* ServiceManager
component.
* ServiceManager
.
* @see com.sun.star.lang.XServiceInfo
*/
public String getImplementationName()
throws com.sun.star.uno.RuntimeException
{
return getClass().getName();
}
/**
* Checks if the ServiceManager
supports a service.
* ServiceEnumerationImpl
class provides an
* implementation of the @see com.sun.star.container.XEnumeration interface.
* It is a inner wrapper for a java.util.Enumeration object.
* ServiceManagerFactory
is the factory class for the
* ServiceManager
. As all factories it implments the
* com.sun.star.lang.XSingleServiceFactory and the com.sun.star.lang.XServiceInfo
* interfaces.
* ServiceManagerFactory
.
*/
public ServiceManagerFactory() {
}
/**
* Supplies the implementation name of the ServiceManager
.
* ServiceManager
class name.
* @see com.sun.star.lang.XServiceInfo
*/
public String getImplementationName()
throws com.sun.star.uno.RuntimeException
{
return ServiceManager.class.getName();
}
/**
* Checks whether or not a service is supported.
* ServiceManager
.
* ServiceManager
object.
* @see com.sun.star.lang.XSingleServiceFactory
*/
public java.lang.Object createInstance()
throws com.sun.star.uno.Exception,
com.sun.star.uno.RuntimeException
{
return new ServiceManager();
}
/**
* Creates a new instance of the ServiceManager
with arguments.
* At this time it always throws a com.sun.star.lang.NoSuchMethodException
* because there is no the ServiceManager
has no constructor with
* arguments.
*