Modifier and Type	Class and Description
private class	LocalOfficeConnection.OfficeService References Deprecated `NativeService` is deprecated or references (maybe indirectly) at least one deprecated element.
private static class	LocalOfficeConnection.StreamProcessor

Field Summary

Modifier and Type	Field and Description
private static final AtomicLong	m_nBridgeCounter
private com.sun.star.bridge.XBridge	mBridge
private final List<com.sun.star.lang.XEventListener>	mComponents
private String	mConnType
private com.sun.star.uno.XComponentContext	mContext
private String	mInitialObject
private String	mPipe
private String	mPort
private Process	mProcess
private String	mProtocol
private String	mURL
public static final String	OFFICE_APP_NAME
public static final String	OFFICE_ID_SUFFIX
public static final String	OFFICE_LIB_NAME

Constructor Summary

Access	Constructor and Description
public	LocalOfficeConnection() Constructor.
protected	LocalOfficeConnection(com.sun.star.uno.XComponentContext xContext) protected Constructor Initialise a LocalOfficeConnection with an already running office.

Method Summary

Modifier and Type	Method and Description
public void	addEventListener(com.sun.star.lang.XEventListener is a listener object. listener) Adds an event listener to the object.
private com.sun.star.uno.XComponentContext	connect() Establishes the connection to the office.
public OfficeWindow	Returns: The office window instance. createOfficeWindow(Container This is an AWT container. container) Implements com.sun.star.comp.beans.OfficeConnection.createOfficeWindow. Deprecated Creates an office java.awt.Canvas based window.
public void	dispose() Closes the connection.
public synchronized com.sun.star.uno.XComponentContext	Returns: The office UNO component context. getComponentContext() Implements com.sun.star.comp.beans.OfficeConnection.getComponentContext. Retrieves the UNO component context.
private static String	getPipeName() creates a unique pipe name.
private void	parseUnoUrlWithOfficePath(String This is UNO URL which describes the type of a connection. url, String prefix) Parses a connection URL.
public void	removeEventListener(com.sun.star.lang.XEventListener is a listener object. listener) Removes an event listener from the listener list.
private Object	resolve(com.sun.star.uno.XComponentContext xLocalContext, String dcp)
public void	setContainerFactory(ContainerFactory This is an application provided AWT container factory. containerFactory) Implements com.sun.star.comp.beans.OfficeConnection.setContainerFactory. Deprecated Sets an AWT container factory.
public void	setUnoUrl(String This is UNO URL which describes the type of a connection. url) Implements com.sun.star.comp.beans.OfficeConnection.setUnoUrl. Sets a connection URL.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

m_nBridgeCounter	back to summary
private static final AtomicLong m_nBridgeCounter

mBridge	back to summary
private com.sun.star.bridge.XBridge mBridge

mComponents	back to summary
private final List<com.sun.star.lang.XEventListener> mComponents

mConnType	back to summary
private String mConnType

mContext	back to summary
private com.sun.star.uno.XComponentContext mContext

mInitialObject	back to summary
private String mInitialObject

mPipe	back to summary
private String mPipe

mPort	back to summary
private String mPort

mProcess	back to summary
private Process mProcess

mProtocol	back to summary
private String mProtocol

mURL	back to summary
private String mURL

OFFICE_APP_NAME	back to summary
public static final String OFFICE_APP_NAME

OFFICE_ID_SUFFIX	back to summary
public static final String OFFICE_ID_SUFFIX

OFFICE_LIB_NAME	back to summary
public static final String OFFICE_LIB_NAME

Constructor Detail

LocalOfficeConnection	back to summary
public LocalOfficeConnection() Constructor. Sets up paths to the office application and native libraries if values are available in `OFFICE_PROP_FILE` in the user home directory. "com.sun.star.beans.path" - the office application directory; "com.sun.star.beans.libpath" - native libraries directory.

LocalOfficeConnection	back to summary
protected LocalOfficeConnection(com.sun.star.uno.XComponentContext xContext) protected Constructor Initialise a LocalOfficeConnection with an already running office. This C'Tor is only used in complex tests at the moment.

Method Detail

addEventListener	back to summary
public void addEventListener(com.sun.star.lang.XEventListener listener) Adds an event listener to the object. Parameters listener:com.sun.star.lang.XEventListener is a listener object.

addEventListener

back to summary

public void addEventListener(com.sun.star.lang.XEventListener listener)

Adds an event listener to the object.

Parameters

listener:com.sun.star.lang.XEventListener: is a listener object.

connect	back to summary
private com.sun.star.uno.XComponentContext connect() Establishes the connection to the office.

createOfficeWindow	back to summary
public OfficeWindow createOfficeWindow(Container container) Implements com.sun.star.comp.beans.OfficeConnection.createOfficeWindow. Deprecated Creates an office java.awt.Canvas based window. Parameters container:Container This is an AWT container. Returns:OfficeWindow The office window instance. Annotations @Deprecated

createOfficeWindow

back to summary

public OfficeWindow createOfficeWindow(Container container)

Implements com.sun.star.comp.beans.OfficeConnection.createOfficeWindow.

Deprecated

Creates an office java.awt.Canvas based window.

Parameters

container:Container: This is an AWT container.

Returns:OfficeWindow

The office window instance.

Annotations

@Deprecated

dispose	back to summary
public void dispose() Closes the connection.

getComponentContext back to summary

getComponentContext	back to summary
public synchronized com.sun.star.uno.XComponentContext getComponentContext() Implements com.sun.star.comp.beans.OfficeConnection.getComponentContext. Retrieves the UNO component context. Establishes a connection if necessary and initialises the UNO service manager if it has not already been initialised. This method can return `null` if it fails to connect to the office application. Returns:com.sun.star.uno.XComponentContext The office UNO component context.

public synchronized com.sun.star.uno.XComponentContext getComponentContext()

Implements com.sun.star.comp.beans.OfficeConnection.getComponentContext.

Retrieves the UNO component context. Establishes a connection if necessary and initialises the UNO service manager if it has not already been initialised. This method can return null if it fails to connect to the office application.

Returns:com.sun.star.uno.XComponentContext: The office UNO component context.

getPipeName	back to summary
private static String getPipeName() throws UnsupportedEncodingException creates a unique pipe name.

parseUnoUrlWithOfficePath	back to summary
private void parseUnoUrlWithOfficePath(String url, String prefix) throws MalformedURLException Parses a connection URL. This method accepts a UNO URL with following format: url := uno:localoffice[,<params>];urp;StarOffice.NamingService params := <path>[,<pipe>] path := path=<pathv> pipe := pipe=<pipev> pathv := platform_specific_path_to_the_local_office_distribution pipev := local_office_connection_pipe_name Examples "uno:localoffice,pipe=xyz_Office,path=/opt/openoffice11/program;urp;StarOffice.ServiceManager"; "uno:socket,host=localhost,port=8100;urp;StarOffice.ServiceManager"; Parameters url:String This is UNO URL which describes the type of a connection. Exceptions MalformedURLException: when inappropriate URL was provided.

parseUnoUrlWithOfficePath

back to summary

private void parseUnoUrlWithOfficePath(String url, String prefix) throws MalformedURLException

Parses a connection URL. This method accepts a UNO URL with following format:

url    := uno:localoffice[,<params>];urp;StarOffice.NamingService
params := <path>[,<pipe>]
path   := path=<pathv>
pipe   := pipe=<pipev>
pathv  := platform_specific_path_to_the_local_office_distribution
pipev  := local_office_connection_pipe_name

Examples

"uno:localoffice,pipe=xyz_Office,path=/opt/openoffice11/program;urp;StarOffice.ServiceManager";
"uno:socket,host=localhost,port=8100;urp;StarOffice.ServiceManager";

Parameters

url:String: This is UNO URL which describes the type of a connection.

Exceptions

MalformedURLException:: when inappropriate URL was provided.

removeEventListener	back to summary
public void removeEventListener(com.sun.star.lang.XEventListener listener) Removes an event listener from the listener list. Parameters listener:com.sun.star.lang.XEventListener is a listener object.

removeEventListener

back to summary

public void removeEventListener(com.sun.star.lang.XEventListener listener)

Removes an event listener from the listener list.

Parameters

listener:com.sun.star.lang.XEventListener: is a listener object.

resolve	back to summary
private Object resolve(com.sun.star.uno.XComponentContext xLocalContext, String dcp) throws com.sun.star.connection.NoConnectException, com.sun.star.connection.ConnectionSetupException, com.sun.star.lang.IllegalArgumentException

setContainerFactory	back to summary
public void setContainerFactory(ContainerFactory containerFactory) Implements com.sun.star.comp.beans.OfficeConnection.setContainerFactory. Deprecated Sets an AWT container factory. Parameters containerFactory:ContainerFactory This is an application provided AWT container factory. Annotations @Deprecated

setContainerFactory

back to summary

public void setContainerFactory(ContainerFactory containerFactory)

Implements com.sun.star.comp.beans.OfficeConnection.setContainerFactory.

Deprecated

Sets an AWT container factory.

Parameters

containerFactory:ContainerFactory: This is an application provided AWT container factory.

Annotations

@Deprecated

setUnoUrl	back to summary
public void setUnoUrl(String url) throws MalformedURLException Implements com.sun.star.comp.beans.OfficeConnection.setUnoUrl. Sets a connection URL. This implementation accepts a UNO URL with following format: url := uno:localoffice[,<params>];urp;StarOffice.ServiceManager params := <path>[,<pipe>] path := path=<pathv> pipe := pipe=<pipev> pathv := platform_specific_path_to_the_local_office_distribution pipev := local_office_connection_pipe_name Parameters url:String This is UNO URL which describes the type of a connection.

setUnoUrl

back to summary

public void setUnoUrl(String url) throws MalformedURLException

Implements com.sun.star.comp.beans.OfficeConnection.setUnoUrl.

Sets a connection URL. This implementation accepts a UNO URL with following format:

url    := uno:localoffice[,<params>];urp;StarOffice.ServiceManager
params := <path>[,<pipe>]
path   := path=<pathv>
pipe   := pipe=<pipev>
pathv  := platform_specific_path_to_the_local_office_distribution
pipev  := local_office_connection_pipe_name

Parameters

url:String: This is UNO URL which describes the type of a connection.

com.sun.star.comp.beans back to summary

private Class LocalOfficeConnection.OfficeService

Class Inheritance

extends Object
implements NativeService

java.lang.Object
com.sun.star.comp.beans.LocalOfficeConnection.OfficeService

All Implemented Interfaces

com.sun.star.comp.beans.NativeService

References Deprecated

NativeService is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Constructor Summary

Access	Constructor and Description
private	OfficeService()

Method Summary

Modifier and Type	Method and Description
public String	Returns: The identifier of the office service. getIdentifier() Implements com.sun.star.comp.beans.NativeService.getIdentifier. Retrieve the office service identifier.
public int	Returns: The amount of time to wait in seconds(?). getStartupTime() Implements com.sun.star.comp.beans.NativeService.getStartupTime. Retrieves the amount of time to wait for the startup.
public void	startupService() Implements com.sun.star.comp.beans.NativeService.startupService. Starts the office process.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

OfficeService	back to summary
private OfficeService()

Method Detail

getIdentifier	back to summary
public String getIdentifier() Implements com.sun.star.comp.beans.NativeService.getIdentifier. Retrieve the office service identifier. Returns:String The identifier of the office service.

getIdentifier

back to summary

public String getIdentifier()

Implements com.sun.star.comp.beans.NativeService.getIdentifier.

Retrieve the office service identifier.

Returns:String: The identifier of the office service.

getStartupTime	back to summary
public int getStartupTime() Implements com.sun.star.comp.beans.NativeService.getStartupTime. Retrieves the amount of time to wait for the startup. Returns:int The amount of time to wait in seconds(?).

getStartupTime

back to summary

public int getStartupTime()

Implements com.sun.star.comp.beans.NativeService.getStartupTime.

Retrieves the amount of time to wait for the startup.

Returns:int: The amount of time to wait in seconds(?).

startupService	back to summary
public void startupService() throws IOException Implements com.sun.star.comp.beans.NativeService.startupService. Starts the office process.

startupService

back to summary

public void startupService() throws IOException

Implements com.sun.star.comp.beans.NativeService.startupService.

Starts the office process.

com.sun.star.comp.beans back to summary

private Class LocalOfficeConnection.StreamProcessor

Class Inheritance

extends Thread

java.lang.Object
java.lang.Thread
com.sun.star.comp.beans.LocalOfficeConnection.StreamProcessor

Field Summary

Modifier and Type	Field and Description
private final InputStream	m_in
private final PrintStream	m_print

Inherited from java.lang.Thread:: MAX_PRIORITY MIN_PRIORITY NORM_PRIORITY

Constructor Summary

Access	Constructor and Description
public	StreamProcessor(final InputStream in, final PrintStream out)

Method Summary

Modifier and Type	Method and Description
public void	run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. This method is run by the thread when it executes.

Field Detail

m_in	back to summary
private final InputStream m_in

m_print	back to summary
private final PrintStream m_print

Constructor Detail

StreamProcessor	back to summary
public StreamProcessor(final InputStream in, final PrintStream out)

Method Detail

run back to summary

run	back to summary
public void run() Overrides java.lang.Thread.run. Implements java.lang.Runnable.run. Doc from java.lang.Thread.run. This method is run by the thread when it executes. Subclasses of `Thread` may override this method. This method is not intended to be invoked directly. If this thread is a platform thread created with a `Runnable` task then invoking this method will invoke the task's `run` method. If this thread is a virtual thread then invoking this method directly does nothing. Annotations @Override

public void run()

Overrides java.lang.Thread.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Thread.run.

This method is run by the thread when it executes. Subclasses of Thread may override this method.

This method is not intended to be invoked directly. If this thread is a platform thread created with a Runnable task then invoking this method will invoke the task's run method. If this thread is a virtual thread then invoking this method directly does nothing.

Annotations

@Override

public Class LocalOfficeConnection

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

Examples

private Class LocalOfficeConnection.OfficeService

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class LocalOfficeConnection.StreamProcessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail