es.caib.ibkey.oppenoffice.helper
Class BootstrapConnector

java.lang.Object
  es.caib.ibkey.oppenoffice.helper.BootstrapConnector

All Implemented Interfaces:

com.sun.star.frame.XTerminateListener, com.sun.star.lang.XEventListener, com.sun.star.uno.XInterface, java.util.EventListener

public class BootstrapConnector
extends java.lang.Object
implements com.sun.star.frame.XTerminateListener

A bootstrap connector which handles a connection to an OOo server. Most of the source code in this class has been taken from the Java class "Bootstrap.java" (Revision: 1.15) from the UDK projekt (Uno Software Develop- ment Kit) from OpenOffice.org (http://udk.openoffice.org/). The source code is available for example through a browser based online version control access at http://udk.openoffice.org/source/browse/udk/. The Java class "Bootstrap.java" is there available at http://udk.openoffice.org/source/browse/udk/javaunohelper/com/sun/star/comp/helper/Bootstrap.java?view=markup The idea to develop this BootstrapConnector comes from the blog "Getting started with the OpenOffice.org API part III : starting OpenOffice.org with jars not in the OOo install dir by Wouter van Reeven" (http://technology.amis.nl/blog/?p=1284) and from various posts in the "(Unofficial) OpenOffice.org Forum" at http://www.oooforum.org/ and the "OpenOffice.org Community Forum" at http://user.services.openoffice.org/ complaining about "no office executable found!". Modified by Pere Joseph 02-09-2009 to allow concurrency with one instance of openoffice and clean resources on disconect

Field Summary

Fields inherited from interface com.sun.star.frame.XTerminateListener

UNOTYPEINFO

Constructor Summary

BootstrapConnector(OOoServer oooServer)
Constructs a bootstrap connector which connects to the specified OOo server.

BootstrapConnector(java.lang.String oooExecFolder)
Constructs a bootstrap connector which uses the folder of the OOo installation containing the soffice executable.

Method Summary

static com.sun.star.uno.XComponentContext	bootstrap(java.lang.String oooExecFolder, java.lang.String oooAcceptOption, java.lang.String oooConnectionString) Bootstraps a connection to an OOo server in the specified soffice executable folder of the OOo installation using the specified accept option and connection string and returns a component context for using the connection to the OOo server.
com.sun.star.uno.XComponentContext	connect(java.lang.String oooAcceptOption, java.lang.String oooConnectionString) Connects to an OOo server using the specified accept option and connection string and returns a component context for using the connection to the OOo server.
void	disconnect() Disconnects from an OOo server using the connection string from the previous connect.
void	disposing(com.sun.star.lang.EventObject arg0)
void	kill() Kills the OpenOffice instance
void	notifyTermination(com.sun.star.lang.EventObject arg0) Handles termination notification after it can be cancelled
void	queryTermination(com.sun.star.lang.EventObject arg0) Handles termination notification, and here is allowed to cancel the termination

Methods inherited from class java.lang.Object

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

Constructor Detail

BootstrapConnector

public BootstrapConnector(java.lang.String oooExecFolder)

Constructs a bootstrap connector which uses the folder of the OOo installation containing the soffice executable.

Parameters:

oooExecFoder - The folder of the OOo installation containing the soffice executable

BootstrapConnector

public BootstrapConnector(OOoServer oooServer)

Constructs a bootstrap connector which connects to the specified OOo server.

Parameters:

oooServer - The OOo server

Method Detail

connect

public com.sun.star.uno.XComponentContext connect(java.lang.String oooAcceptOption,
                                                  java.lang.String oooConnectionString)
                                           throws com.sun.star.comp.helper.BootstrapException

Connects to an OOo server using the specified accept option and connection string and returns a component context for using the connection to the OOo server. The accept option and the connection string should match to get a connection. OOo provides to different types of connections: 1) The socket connection 2) The named pipe connection To create a socket connection a host and port must be provided. For example using the host "localhost" and the port "8100" the accept option and connection string looks like this: - accept option : -accept=socket,host=localhost,port=8100;urp; - connection string: uno:socket,host=localhost,port=8100;urp;StarOffice.ComponentContext To create a named pipe a pipe name must be provided. For example using the pipe name "oooPipe" the accept option and connection string looks like this: - accept option : -accept=pipe,name=oooPipe;urp; - connection string: uno:pipe,name=oooPipe;urp;StarOffice.ComponentContext

Parameters:

oooAcceptOption - The accept option

oooConnectionString - The connection string

Returns:

The component context

Throws:

com.sun.star.comp.helper.BootstrapException

disconnect

public void disconnect()

Disconnects from an OOo server using the connection string from the previous connect. If there has been no previous connect, the disconnects does nothing. If there has been a previous connect, disconnect tries to terminate the OOo server and kills the OOo server process the connect started.

kill

public void kill()

Kills the OpenOffice instance

bootstrap

public static final com.sun.star.uno.XComponentContext bootstrap(java.lang.String oooExecFolder,
                                                                 java.lang.String oooAcceptOption,
                                                                 java.lang.String oooConnectionString)
                                                          throws com.sun.star.comp.helper.BootstrapException

Bootstraps a connection to an OOo server in the specified soffice executable folder of the OOo installation using the specified accept option and connection string and returns a component context for using the connection to the OOo server. The accept option and the connection string should match in connection type and pipe name or host and port to get a connection.

Parameters:

oooExecFolder - The folder of the OOo installation containing the soffice executable

oooAcceptOption - The accept option

oooConnectionString - The connection string

Returns:

The component context

Throws:

com.sun.star.comp.helper.BootstrapException

notifyTermination

public void notifyTermination(com.sun.star.lang.EventObject arg0)

Handles termination notification after it can be cancelled

Specified by:

notifyTermination in interface com.sun.star.frame.XTerminateListener

queryTermination

public void queryTermination(com.sun.star.lang.EventObject arg0)
                      throws com.sun.star.frame.TerminationVetoException

Handles termination notification, and here is allowed to cancel the termination

Specified by:

queryTermination in interface com.sun.star.frame.XTerminateListener

Throws:

com.sun.star.frame.TerminationVetoException

disposing

public void disposing(com.sun.star.lang.EventObject arg0)

Specified by:

disposing in interface com.sun.star.lang.XEventListener