com.sun.star.comp.loader

Class JavaLoader

java.lang.Object

com.sun.star.comp.loader.JavaLoader

public class JavaLoader
extends java.lang.Object

The JavaLoader class provides the functionality of the com.sun.star.loader.Java service. Therefor the JavaLoader activates external UNO components which are implemented in Java. The loader is used by the ServiceManger.

Since:

UDK1.0

See Also:

com.sun.star.loader.XImplementationLoader, com.sun.star.loader.Java, ServiceManager, com.sun.star.lang.ServiceManager

Field Summary

Fields

Modifier and Type	Field and Description
protected XMultiServiceFactory	multiServiceFactory

Constructor Summary

Constructors

Constructor and Description
JavaLoader() Creates a new instance of the JavaLoader class.
JavaLoader(XMultiServiceFactory factory) Creates a new JavaLoader object.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	activate(java.lang.String implementationName, java.lang.String implementationLoaderUrl, java.lang.String locationUrl, XRegistryKey xKey) Provides a components factory.
java.lang.String	getImplementationName() Supplies the implementation name of the component.
static XSingleServiceFactory	getServiceFactory(java.lang.String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey) Supplies the factory for the JavaLoader
java.lang.String[]	getSupportedServiceNames() Supplies a list of all service names supported by the component
void	initialize(java.lang.Object[] args) Unlike the original intention, the method could be called every time a new com.sun.star.lang.XMultiServiceFactory should be set at the loader.
boolean	supportsService(java.lang.String serviceName) Verifies if a given service is supported by the component.
boolean	writeRegistryInfo(XRegistryKey regKey, java.lang.String implementationLoaderUrl, java.lang.String locationUrl) Registers the component in a registry under a given root key.
static boolean	writeRegistryServiceInfo(XRegistryKey regKey) Registers the JavaLoader at the registry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

multiServiceFactory

protected XMultiServiceFactory multiServiceFactory

Constructor Detail

JavaLoader

public JavaLoader()

Creates a new instance of the JavaLoader class.

JavaLoader

public JavaLoader(XMultiServiceFactory factory)

Creates a new JavaLoader object. The specified com.sun.star.lang.XMultiServiceFactory is the ServiceManager service which can be deliviert to all components the JavaLoader is loading. To set the MultiServiceFactory you can use the com.sun.star.lang.XInitialization interface, either.

Parameters:

factory - the ServiceManager

See Also:

com.sun.star.lang.ServiceManager, com.sun.star.lang.ServiceManager, com.sun.star.lang.XInitialization

Method Detail

initialize

public void initialize(java.lang.Object[] args)
                throws com.sun.star.uno.Exception,
                       com.sun.star.uno.RuntimeException

Unlike the original intention, the method could be called every time a new com.sun.star.lang.XMultiServiceFactory should be set at the loader.

Parameters:

args - - the first parameter (args[0]) specifices the ServiceManager

Throws:

com.sun.star.uno.Exception

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XInitialization, com.sun.star.lang.ServiceManager

getImplementationName

public java.lang.String getImplementationName()
                                       throws com.sun.star.uno.RuntimeException

Supplies the implementation name of the component.

Returns:

the implementation name - here the class name

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XServiceInfo

supportsService

public boolean supportsService(java.lang.String serviceName)
                        throws com.sun.star.uno.RuntimeException

Verifies if a given service is supported by the component.

Parameters:

serviceName - the name of the service that should be checked

Returns:

true,if service is suported - otherwise false

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XServiceInfo

getSupportedServiceNames

public java.lang.String[] getSupportedServiceNames()
                                            throws com.sun.star.uno.RuntimeException

Supplies a list of all service names supported by the component

Returns:

a String array with all supported services

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XServiceInfo

activate

public java.lang.Object activate(java.lang.String implementationName,
                                 java.lang.String implementationLoaderUrl,
                                 java.lang.String locationUrl,
                                 XRegistryKey xKey)
                          throws CannotActivateFactoryException,
                                 com.sun.star.uno.RuntimeException

Provides a components factory. The JavaLoader tries to load the class first. If a loacation URL is given the RegistrationClassFinder is used to load the class. Otherwise the class is loaded thru the Class.forName method. To get the factory the inspects the class for the optional static member functions __getServiceFactory resp. getServiceFactory (DEPRECATED). If the function can not be found a default factory @see ComponentFactoryWrapper will be created.

Parameters:

implementationName - the implementation (class) name of the component

implementationLoaderUrl - the URL of the implementation loader. Not used.

locationUrl - points to an archive (JAR file) which contains a component

xKey -

Returns:

the factory for the component (@see com.sun.star.lang.XSingleServiceFactory)

Throws:

CannotActivateFactoryException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XImplementationLoader, com.sun.star.com.loader.RegistrationClassFinder

writeRegistryInfo

public boolean writeRegistryInfo(XRegistryKey regKey,
                                 java.lang.String implementationLoaderUrl,
                                 java.lang.String locationUrl)
                          throws CannotRegisterImplementationException,
                                 com.sun.star.uno.RuntimeException

Registers the component in a registry under a given root key. If the component supports the optional methods __writeRegistryServiceInfo, writeRegistryServiceInfo (DEPRECATED), the call is delegated to that method. Otherwise a default registration will be accomplished.

Parameters:

regKey - the root key under that the component should be registred.

implementationLoaderUrl - specifies the loader, the component is loaded by.

locationUrl - points to an archive (JAR file) which contains a component

Returns:

true if registration is successfully - otherwise false

Throws:

CannotRegisterImplementationException

com.sun.star.uno.RuntimeException

See Also:

ComponentFactoryWrapper

getServiceFactory

public static XSingleServiceFactory getServiceFactory(java.lang.String implName,
                                                      XMultiServiceFactory multiFactory,
                                                      XRegistryKey regKey)

Supplies the factory for the JavaLoader

Parameters:

implName - the name of the desired component

multiFactory - the ServiceManager is delivered to the factory

regKey - not used - can be null

Returns:

the factory for the JavaLoader

writeRegistryServiceInfo

public static boolean writeRegistryServiceInfo(XRegistryKey regKey)

Registers the JavaLoader at the registry.

Parameters:

regKey - root key under which the JavaLoader should be regidstered

Returns:

true if registration succseeded - otherwise false