Manual Component Installation

OpenOffice.org Developer's Guide

Writing UNO Components

< Previous Section

Next Section >

• Required Files
• Using UNOIDL to Specify New Components

• Writing the Specification

• Preprocessing
• Grouping Definitions in Modules
• Simple Types
• Defining an Interface
• Defining a Service
• Defining a Sequence
• Defining a Struct
• Defining an Exception
• Predefining Values
• Using Comments
• Singleton
• Reserved Types
• Published Entities

• Generating Source Code from UNOIDL Definitions

• Component Architecture
• Core Interfaces to Implement

• XInterface
• XTypeProvider
• XServiceInfo
• XWeak
• XComponent
• XInitialization
• XMain
• XAggregation
• XUnoTunnel

• Simple Component in Java

• Class Definition with Helper Class
• Implementing Your Own Interfaces
• Providing a Single Factory Using a Helper Method
• Write Registration Info Using a Helper Method
• Implementing without Helpers
• Storing the Service Manager for Further Use
• Create Instance with Arguments
• Possible Structures for Java Components
• Running and Debugging Java Components

• Register Component File
• Make Registration Available to OpenOffice.org
• Test the Registration
• Debugging
• The Java Environment in OpenOffice.org
• Troubleshooting

• C++ Component

• Class Definition with Helper Template Classes
• Implementing your own Interfaces
• Providing a Single Factory Using a Helper Method
• Write Registration Info Using a Helper Method
• Provide Implementation Environment
• Implementing without Helpers
• Storing the Service Manager for Further Use
• Create Instance with Arguments
• Multiple Components in One Dynamic Link Library
• Building and Testing C++ Components

• Integrating Components into OpenOffice.org

• Protocol Handler

• Implementation
• Configuration
• Installation

• Jobs

• Execution Environment
• Implementation
• Initialization
• Returning Results
• Configuration
• Installation
• Using the vnd.sun.star.jobs: URL Schema
• List of Supported Events

• Add-Ons

• Guidelines
• Configuration

• Menus
• Toolbars
• Images for Toolbars and Menus
• Help Integration

• Installation

• Disable Commands
• Intercepting Context Menus

• File Naming Conventions
• Deployment Options for Components

• Command Line Registry Tools
• Manual Component Installation
• Bootstrapping a Service Manager
• Special Service Manager Configurations

• The UNO Executable

• Standalone Use Case
• Server Use Case
• Using the UNO Executable

• Accessing Dialogs

• Assigning Component Methods to Control Events
• Using Dialogs in Components

< Previous Page

Next Page >

Manually Merging a Registry and Adding it to uno.ini or soffice.ini

Registry files used by OpenOffice.org are configured within the uno(.ini|rc) file found in the program directory. After a default OpenOffice.org installation, the files look like this:

 uno.ini :
 [Bootstrap]
 UNO_TYPES=$ORIGIN/types.rdb
 UNO_SERVICES=$ORIGIN/services.rdb

The two UNO variables are relevant for UNO components. The UNO_TYPES variable gives a space separated list of type library registries, and the UNO_SERVICES variable gives a space separated list of registries that contain component registration information. These registries are opened read-only. The same registry may appear in UNO_TYPES and UNO_SERVICES variables. The $ORIGIN points to the directory where the ini/rc file is located.

OpenOffice.org uses the types.rdb as a type and the services.rdb as a component registration information repository. When a programmer or software vendor releases a UNO component, the following files must be provided at a minimum:

• A file containing the code of the new component, for instance a shared library, a jar file, or maybe a python file in the future.
• A registry file containing user defined UNOIDL types, if any.
• (optional) A registry file containing registration information of a pre-registered component. The registry provider should register the component with a relative path to be beneficial in other OpenOffice.org installations.

The latter two can be integrated into a single file.

The recommended method to add a component to OpenOffice.org manually is described in the following steps:

1. Copy new shared library components into the <OfficePath>/program directory and new Java components into the <OfficePath>/program/classes directory.
2. Copy the registry containing the type library into the <OfficePath>/program directory, if needed and available.
3. Copy the registry containing the component registration information into the <OfficePath>/program directory, if required. Otherwise, register the component with the regcomp command line tool coming with the OpenOffice.org SDK into a new registry.
4. Modify the uno(.ini|rc) file, and add the type registry to the UNO_TYPES variable and the component registry to the UNO_SERVICES variable. The new uno(.ini|rc) might look like this:

 [Bootstrap]
 UNO_TYPES=$ORIGIN/types.rdb $ORIGIN/filterxyz_types.rdb
 UNO_SERVICES=$ORIGIN/services.rdb $ORIGIN/filterxyz_services.rdb

After these changes are made, every office that is restarted can use the new component. The uno(.ini|rc) changes directly affect the whole office network installation. If adding a component only for a single user, pass the modified UNO_TYPES and UNO_SERVICES variables per command line. An example might be:

 $ soffice “-env:UNO_TYPES=$ORIGIN/types.rdb 
 $ORIGIN/filterxyz_types.rdb“ 
           “-env:UNO_SERVICES=$ORIGIN/services.rdb 
 $ORIGIN/filter_xyz_services.rdb” ).

Content on this page is licensed under the Public Documentation License (PDL).