com.sun.star.comp.servicemanager

Class ServiceManager

java.lang.Object

com.sun.star.comp.servicemanager.ServiceManager

public class ServiceManager
extends java.lang.Object

The ServiceManager class is an implmentation of the ServiceManagerthe 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.

Since:

UDK1.0

See Also:

com.sun.star.lang.XMultiServiceFactory, com.sun.star.container.XSet, com.sun.star.container.XContentEnumerationAccess, com.sun.star.lang.XComponent, com.sun.star.lang.XServiceInfo, com.sun.star.lang.XInitialization

Constructor Summary

Constructors

Constructor and Description
ServiceManager() Creates a new instance of the ServiceManager.
ServiceManager(XComponentContext xContext) Creates a new instance of the ServiceManager.

Method Summary

Modifier and Type	Method and Description
void	addEventListener(XEventListener xListener) Adds a new EventListener.
XEnumeration	createContentEnumeration(java.lang.String serviceName) Provides an enumeration of of all factorys for a specified service.
XEnumeration	createEnumeration() Provides an enumeration of all registred services.
java.lang.Object	createInstance(java.lang.String serviceSpecifier) Creates a new instance of a specified service.
java.lang.Object	createInstanceWithArguments(java.lang.String serviceSpecifier, java.lang.Object[] args) Creates a new instance of a specified service with the given parameters.
java.lang.Object	createInstanceWithArgumentsAndContext(java.lang.String rServiceSpecifier, java.lang.Object[] rArguments, com.sun.star.uno.XComponentContext xContext) Create a service instance with given context and arguments.
java.lang.Object	createInstanceWithContext(java.lang.String rServiceSpecifier, com.sun.star.uno.XComponentContext xContext) Create a service instance with given context.
void	dispose() Removes all listeners from the ServiceManager and clears the list of the services.
java.lang.String[]	getAvailableServiceNames() Supplies a list of all avialable services names.
com.sun.star.uno.Type	getElementType() Provides the UNO type of the ServiceManager
java.lang.String	getImplementationName() Returns the implementation name of the ServiceManager component.
static XSingleServiceFactory	getServiceFactory(java.lang.String implName, XMultiServiceFactory multiFactory, XRegistryKey regKey) Returns the service factory for the ServiceManager.
java.lang.String[]	getSupportedServiceNames() Supplies list of all supported services.
boolean	has(java.lang.Object object) Checks if a component is registered at the ServiceManager.
boolean	hasElements() Checks if the any componets are registered.
void	initialize(java.lang.Object[] args) The method is used to add components to the ServiceManager.
void	insert(java.lang.Object object) Adds a SingleServiceFactory to the ServiceManager.
void	remove(java.lang.Object object) Removes a SingleServiceFactory from the ServiceManager.
void	removeEventListener(XEventListener xListener) Removes a EventListener from the ServiceManager.
boolean	supportsService(java.lang.String serviceName) Checks if the ServiceManager supports a service.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceManager

public ServiceManager()

Creates a new instance of the ServiceManager.

ServiceManager

public ServiceManager(XComponentContext xContext)

Creates a new instance of the ServiceManager.

Method Detail

getServiceFactory

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

Returns the service factory for the ServiceManager. If the given implementation name does not equal to the ServiceManagers class name null will be returned.

Parameters:

implName - the implementation name of the of the service. Must be equal to com.sun.star.comp.servicemanager.ServicManager

multiFactory - refernce of the MultiServiceFactory. This parameter will be ignored.

regKey - the root key of the registry. This parameter will be ignored.

Returns:

the factory for the ServiceManager.

initialize

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

The method is used to add components to the ServiceManager. The first argument indicates a SimpleRegistry. The components which should be added will be searched under the Implementations key in the registry.

Parameters:

args - the first argument ( args[0] ) specifices the SimpleRegistry object

Throws:

com.sun.star.uno.Exception

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XInitialization, com.sun.star.lang.RegistryServiceManager, com.sun.star.lang.XSimpleRegistry

createInstance

public java.lang.Object createInstance(java.lang.String serviceSpecifier)
                                throws com.sun.star.uno.Exception,
                                       com.sun.star.uno.RuntimeException

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.

Parameters:

serviceSpecifier - indicates the service or component name

Returns:

newly created component

Throws:

com.sun.star.uno.Exception

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XMultiServiceFactory

createInstanceWithArguments

public java.lang.Object createInstanceWithArguments(java.lang.String serviceSpecifier,
                                                    java.lang.Object[] args)
                                             throws com.sun.star.uno.Exception,
                                                    com.sun.star.uno.RuntimeException

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.

Parameters:

serviceSpecifier - indicates the service or component name

Returns:

newly created component

Throws:

com.sun.star.uno.Exception

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XMultiServiceFactory

getAvailableServiceNames

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

Supplies a list of all avialable services names.

Returns:

list of Strings of all service names

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.container.XContentEnumerationAccess

createInstanceWithContext

public java.lang.Object createInstanceWithContext(java.lang.String rServiceSpecifier,
                                                  com.sun.star.uno.XComponentContext xContext)
                                           throws com.sun.star.uno.Exception

Create a service instance with given context.

Parameters:

rServiceSpecifier - service name

xContext - context

Returns:

service instance

Throws:

com.sun.star.uno.Exception

createInstanceWithArgumentsAndContext

public java.lang.Object createInstanceWithArgumentsAndContext(java.lang.String rServiceSpecifier,
                                                              java.lang.Object[] rArguments,
                                                              com.sun.star.uno.XComponentContext xContext)
                                                       throws com.sun.star.uno.Exception

Create a service instance with given context and arguments.

Parameters:

rServiceSpecifier - service name

rArguments - arguments

xContext - context

Returns:

service instance

Throws:

com.sun.star.uno.Exception

dispose

public void dispose()
             throws com.sun.star.uno.RuntimeException

Removes all listeners from the ServiceManager and clears the list of the services.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XComponent

addEventListener

public void addEventListener(XEventListener xListener)
                      throws com.sun.star.uno.RuntimeException

Adds a new 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.

Parameters:

xListener - the new listener which should been added.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XComponent

removeEventListener

public void removeEventListener(XEventListener xListener)
                         throws com.sun.star.uno.RuntimeException

Removes a EventListener from the ServiceManager. If the listener is not registered a com.sun.star.uno.RuntimeException will be thrown.

Parameters:

xListener - the new listener which should been removed.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XComponent

has

public boolean has(java.lang.Object object)
            throws com.sun.star.uno.RuntimeException

Checks if a component is registered at the ServiceManager. The given object argument must provide a XServiceInfo interface.

Parameters:

object - object which provides a XServiceInfo interface.

Returns:

true if the component is registred otherwise false.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.container.XSet, com.sun.star.lang.XServiceInfo

insert

public void insert(java.lang.Object object)
            throws com.sun.star.lang.IllegalArgumentException,
                   com.sun.star.container.ElementExistException,
                   com.sun.star.uno.RuntimeException

Adds a SingleServiceFactory to the ServiceManager.

Parameters:

object - factory which should be added.

Throws:

com.sun.star.lang.IllegalArgumentException

com.sun.star.container.ElementExistException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.container.XSet, com.sun.star.lang.XSingleServiceFactory

remove

public void remove(java.lang.Object object)
            throws com.sun.star.lang.IllegalArgumentException,
                   com.sun.star.container.NoSuchElementException,
                   com.sun.star.uno.RuntimeException

Removes a SingleServiceFactory from the ServiceManager.

Parameters:

object - factory which should be removed.

Throws:

com.sun.star.lang.IllegalArgumentException

com.sun.star.container.NoSuchElementException

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.container.XSet, com.sun.star.lang.XSingleServiceFactory

createEnumeration

public XEnumeration createEnumeration()
                               throws com.sun.star.uno.RuntimeException

Provides an enumeration of all registred services.

Returns:

an enumeration of all avialable services.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.conatiner.XEnumerationAccess

getElementType

public com.sun.star.uno.Type getElementType()
                                     throws com.sun.star.uno.RuntimeException

Provides the UNO type of the ServiceManager

Returns:

the UNO type of the ServiceManager.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.container.XElementAccess, com.sun.star.uno.TypeClass

hasElements

public boolean hasElements()

Checks if the any componets are registered.

Returns:

true - if the list of the registred components is not empty - otherwise false.

See Also:

com.sun.star.container.XElementAccess

createContentEnumeration

public XEnumeration createContentEnumeration(java.lang.String serviceName)
                                      throws com.sun.star.uno.RuntimeException

Provides an enumeration of of all factorys for a specified service.

Parameters:

serviceName - name of the requested service

Returns:

an enumeration for service name.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.container.XContentEnumerationAccess

getImplementationName

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

Returns the implementation name of the ServiceManager component.

Returns:

the class name of the ServiceManager.

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

Checks if the ServiceManager supports a service.

Parameters:

serviceName - service name which should be checked.

Returns:

true if the service is supported - 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 list of all supported services.

Returns:

a list of all supported service names.

Throws:

com.sun.star.uno.RuntimeException

See Also:

com.sun.star.lang.XServiceInfo