org.jodconverter.local.office

Class OfficeConnection

java.lang.Object

org.jodconverter.local.office.OfficeConnection

All Implemented Interfaces:

com.sun.star.lang.XEventListener, com.sun.star.uno.XInterface, EventListener, org.jodconverter.core.office.OfficeContext, LocalOfficeContext

public class OfficeConnection
extends Object
implements LocalOfficeContext, com.sun.star.lang.XEventListener

An OfficeConnection is responsible to manage the connection to an office process using a given UnoUrl.

Field Summary

Fields inherited from interface com.sun.star.lang.XEventListener

UNOTYPEINFO

Constructor Summary

Constructors

Constructor and Description
OfficeConnection(@NonNull org.jodconverter.local.office.OfficeUrl officeUrl) Constructs a new connection for the specified UNO URL.

Method Summary

Modifier and Type	Method and Description
void	addConnectionEventListener(@NonNull org.jodconverter.local.office.OfficeConnectionEventListener connectionEventListener) Adds a listener to the connection event listener list of this connection.
void	connect() Establishes the connection to an office instance.
void	disconnect() Closes the connection.
void	disposing(@NonNull com.sun.star.lang.EventObject eventObject)
@Nullable com.sun.star.uno.XComponentContext	getComponentContext() Gets the ComponentContext interface of the remote component context.
@Nullable com.sun.star.frame.XComponentLoader	getComponentLoader() Gets the office component loader for this context.
@Nullable com.sun.star.frame.XDesktop	getDesktop() Gets the Desktop interface of the desktop service.
@Nullable com.sun.star.lang.XMultiComponentFactory	getServiceManager() Gets the MultiComponentFactory interface of the remote service manager.
boolean	isConnected() Gets whether we are connected to an office instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

OfficeConnection

public OfficeConnection(@NonNull org.jodconverter.local.office.OfficeUrl officeUrl)

Constructs a new connection for the specified UNO URL.

Parameters:

officeUrl - The URL for which the connection is created.

Method Detail

addConnectionEventListener

public void addConnectionEventListener(@NonNull org.jodconverter.local.office.OfficeConnectionEventListener connectionEventListener)

Adds a listener to the connection event listener list of this connection.

Parameters:

connectionEventListener - The listener to add. It will be notified when a connection is established with an office process and when a connection is lost.

connect

public void connect()
             throws OfficeConnectionException

Establishes the connection to an office instance.

Throws:

OfficeConnectionException - If the connection could not be established.

disconnect

public void disconnect()

Closes the connection.

disposing

public void disposing(@NonNull com.sun.star.lang.EventObject eventObject)

Specified by:

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

getComponentContext

public @Nullable com.sun.star.uno.XComponentContext getComponentContext()

Description copied from interface: LocalOfficeContext

Gets the ComponentContext interface of the remote component context.

Specified by:

getComponentContext in interface LocalOfficeContext

Returns:

The XComponentContext.

getServiceManager

public @Nullable com.sun.star.lang.XMultiComponentFactory getServiceManager()

Description copied from interface: LocalOfficeContext

Gets the MultiComponentFactory interface of the remote service manager.

Specified by:

getServiceManager in interface LocalOfficeContext

Returns:

The XMultiComponentFactory.

getComponentLoader

public @Nullable com.sun.star.frame.XComponentLoader getComponentLoader()

Description copied from interface: LocalOfficeContext

Gets the office component loader for this context.

Specified by:

getComponentLoader in interface LocalOfficeContext

Returns:

The XComponentLoader.

getDesktop

public @Nullable com.sun.star.frame.XDesktop getDesktop()

Description copied from interface: LocalOfficeContext

Gets the Desktop interface of the desktop service.

Specified by:

getDesktop in interface LocalOfficeContext

Returns:

The XDesktop.

isConnected

public boolean isConnected()

Gets whether we are connected to an office instance.

Returns:

true if we are connected to an office instance; false otherwise.