com.openfin.desktop

Class DesktopConnection

java.lang.Object

com.openfin.desktop.DesktopConnection

public class DesktopConnection
extends Object

A object for launching, connecting to, and controlling Runtime.

Constructor Summary

Constructors

Constructor and Description
DesktopConnection(String uuid) Creates a new connection to Runtime
DesktopConnection(String uuid, String host, Integer port) Deprecated. use DesktopConnection(String) instead.

Method Summary

Modifier and Type	Method and Description
void	addAppAsset(String config) Deprecated. use RuntimeConfiguration instead
void	addEventCallback(org.json.JSONObject subscriptionObject, EventListener listener, AckListener callback, Object source) Registers an event listener on the specified event
void	addExternalMessageHandler(ExternalMessageListener listener, Object source) Registers a listener to handle messages for this connection's UUID originating via HTTPS/HTTP
void	connect(DesktopStateListener listener) Connects to an Runtime process.
void	connect(RuntimeConfiguration configuration, DesktopStateListener listener, int timeout) Connect to Runtime with the specified configuration.
void	connectToVersion(String runtimeVersion, DesktopStateListener listener, int timeout) Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.
void	disconnect() Disconnects from Runtime
protected void	disconnect(String reason)
void	exit() Notify Runtime to exit
Channel	getChannel(String name) Get specified channel.
InterApplicationBus	getInterApplicationBus() Gets the Inter-Application message dispatcher associated with this DesktopConnection
Integer	getPort() Gets port number that Runtime is running on
boolean	isConnected() InterApplicationBus
void	launchAndConnect(String commandLineArguments, DesktopStateListener listener, int timeout) Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.
void	launchAndConnect(String desktopPath, String commandLineArguments, DesktopStateListener listener, int timeout) Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.
Integer	registerNotificationListener(NotificationListener listener, Object source) Registers listener for a new notification
void	removeEventCallback(org.json.JSONObject subscriptionObject, EventListener listener, AckListener callback, Object source) Removes a previously registered event listener from the specified event
protected void	respondToPing(long pingId)
void	sendAction(String action, org.json.JSONObject payload) Sends a message to Runtime
void	sendAction(String action, org.json.JSONObject payload, AckListener listener, Object source) Sends a message to Runtime
CompletableFuture<ChannelClient>	sendActionAsync(String action, org.json.JSONObject payload)
void	sendActionToNotificationsCenter(String action, org.json.JSONObject payload, AckListener callback, Object source)
void	setAdditionalRuntimeArguments(String additionalRuntimeArguments) Deprecated. use RuntimeConfiguration instead
void	setAdditionalRvmArguments(String additionalRvmArguments) Deprecated. use RuntimeConfiguration instead
void	setDevToolsPort(int port) Deprecated. use RuntimeConfiguration instead
void	setLogLevel(boolean enabled) Deprecated.
void	setRdmUrl(String url) Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.
void	setRuntimeAssetsUrl(String url) Deprecated. use RuntimeConfiguration instead
void	setRuntimeSecurityRealm(String runtimeSecurityRealm) Deprecated. use RuntimeConfiguration instead

Methods inherited from class java.lang.Object

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

Constructor Detail

DesktopConnection

public DesktopConnection(String uuid)
                  throws DesktopException

Creates a new connection to Runtime

Parameters:

uuid - unique ID for Runtime to refer to this DesktopConnection

Throws:

DesktopException - if this method fails to create a connection

DesktopConnection

public DesktopConnection(String uuid,
                         String host,
                         Integer port)
                  throws DesktopException

Deprecated. use DesktopConnection(String) instead.

Creates a new connection to Runtime

Parameters:

uuid - unique ID for Runtime to refer to this DesktopConnection

host - The host that Runtime is running on. Only "localhost" is accepted

port - The port that Runtime is listening on for connections. -null if unknown

Throws:

DesktopException - if this method fails to create a connection

Method Detail

launchAndConnect

public void launchAndConnect(String commandLineArguments,
                             DesktopStateListener listener,
                             int timeout)
                      throws URISyntaxException,
                             DesktopIOException

Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.

Launches Runtime and notifies the listener when connected. This method launches OpenFinRVM.exe embedded in the jar.

Parameters:

commandLineArguments - Command line arguments to start the Runtime with

listener - Receives updates on startup and connection state

timeout - For connecting to Desktop after launch. If the connection to Runtime is not established by the timeout the listener will get an onError() call

Throws:

URISyntaxException - if URL has invalid syntax

DesktopIOException - if this method fails to connect to Runtime

launchAndConnect

public void launchAndConnect(String desktopPath,
                             String commandLineArguments,
                             DesktopStateListener listener,
                             int timeout)
                      throws DesktopIOException

Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.

Launches Runtime and notifies the listener when connected.

Parameters:

desktopPath - Absolute path to the Runtime executable

commandLineArguments - Command line arguments to start the Runtime with

listener - Receives updates on startup and connection state

timeout - For connecting to Desktop after launch. If the connection to Runtime is not established by the timeout the listener will get an onError() call

Throws:

DesktopIOException - if this method fails to connect to Runtime

connectToVersion

public void connectToVersion(String runtimeVersion,
                             DesktopStateListener listener,
                             int timeout)
                      throws DesktopIOException,
                             IOException

Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.

Connect to specified version of Desktop. If the specified version is not running, this method will try to start it.

Parameters:

runtimeVersion - version of Runtime required

listener - Receives updates on startup and connection state

timeout - number of seconds to wait for connection. If connection to Runtime is not established by the timeout the listener will get an onError() call

Throws:

DesktopIOException - if this method fails to connect to Runtime

IOException - if IO exception is thrown during launching Runtime

connect

public void connect(RuntimeConfiguration configuration,
                    DesktopStateListener listener,
                    int timeout)
             throws DesktopIOException,
                    IOException

Connect to Runtime with the specified configuration. If the specified version is not running, this method will try to start it.

Parameters:

configuration - an instance of RuntimeConfiguration

listener - Receives updates on startup and connection state

timeout - number of seconds to wait for connection. If connection to Runtime is not established by the timeout the listener will get an onError() call

Throws:

DesktopIOException - if this method fails to connect to Runtime

IOException - if IO exception is thrown during launching Runtime

See Also:

RuntimeConfiguration

disconnect

public void disconnect()
                throws DesktopException

Disconnects from Runtime

Throws:

DesktopException - if this method fails to disconnect from Runtime

disconnect

protected void disconnect(String reason)
                   throws DesktopException

Throws:

DesktopException

isConnected

public boolean isConnected()

InterApplicationBus

Returns:

true if connected

exit

public void exit()
          throws DesktopException

Notify Runtime to exit

Throws:

DesktopException - if this method fails to exit

getInterApplicationBus

public InterApplicationBus getInterApplicationBus()

Gets the Inter-Application message dispatcher associated with this DesktopConnection

Returns:

InterApplicationBus

getPort

public Integer getPort()

Gets port number that Runtime is running on

Returns:

port number

sendAction

public void sendAction(String action,
                       org.json.JSONObject payload)
                throws DesktopException

Sends a message to Runtime

Parameters:

action - The action of the message

payload - The message object to send

Throws:

DesktopException - if this method fails to send the message

sendAction

public void sendAction(String action,
                       org.json.JSONObject payload,
                       AckListener listener,
                       Object source)

Sends a message to Runtime

Parameters:

action - The action of the message

payload - The message object to send

listener - AckListener for the message

source - Message source

See Also:

AckListener

sendActionAsync

public CompletableFuture<ChannelClient> sendActionAsync(String action,
                                                        org.json.JSONObject payload)

connect

public void connect(DesktopStateListener listener)

Connects to an Runtime process. Internal use only

Parameters:

listener - Receives updates on startup and connection state

See Also:

DesktopStateListener

registerNotificationListener

public Integer registerNotificationListener(NotificationListener listener,
                                            Object source)

Registers listener for a new notification

Parameters:

listener - NotificationListener for the notification

source - Source of the request

Returns:

Notification Id

See Also:

NotificationListener

sendActionToNotificationsCenter

public void sendActionToNotificationsCenter(String action,
                                            org.json.JSONObject payload,
                                            AckListener callback,
                                            Object source)

addEventCallback

public void addEventCallback(org.json.JSONObject subscriptionObject,
                             EventListener listener,
                             AckListener callback,
                             Object source)

Registers an event listener on the specified event

Parameters:

subscriptionObject - JSON object containing subscription information such as the topic and type

listener - EventListener for the event

callback - AckListener for this request

source - Source of this request

See Also:

EventListener, AckListener

removeEventCallback

public void removeEventCallback(org.json.JSONObject subscriptionObject,
                                EventListener listener,
                                AckListener callback,
                                Object source)

Removes a previously registered event listener from the specified event

Parameters:

subscriptionObject - JSON object containing subscription information such as the topic and type

listener - EventListener that was registered before

callback - AckListener for this request

source - source of this request

respondToPing

protected void respondToPing(long pingId)

addExternalMessageHandler

public void addExternalMessageHandler(ExternalMessageListener listener,
                                      Object source)

Registers a listener to handle messages for this connection's UUID originating via HTTPS/HTTP

Parameters:

listener - process a received HTTPS/HTTP message for this connection

source - The object that originally registered the listener

setAdditionalRuntimeArguments

public void setAdditionalRuntimeArguments(String additionalRuntimeArguments)

Deprecated. use RuntimeConfiguration instead

Set additional runtime arguments passed to the Runtime

Parameters:

additionalRuntimeArguments - additional arguments, such as "--v=1" to enable more logging

setAdditionalRvmArguments

public void setAdditionalRvmArguments(String additionalRvmArguments)

Deprecated. use RuntimeConfiguration instead

Set additional runtime arguments passed to the RVM

Parameters:

additionalRvmArguments - additional arguments

setRuntimeSecurityRealm

public void setRuntimeSecurityRealm(String runtimeSecurityRealm)

Deprecated. use RuntimeConfiguration instead

Set security realm of the Runtime

Parameters:

runtimeSecurityRealm - name of the realm

setRdmUrl

public void setRdmUrl(String url)

Deprecated. use connect(RuntimeConfiguration, DesktopStateListener, int) instead.

Set URL of RDM service

Parameters:

url - URL of RDM service

setDevToolsPort

public void setDevToolsPort(int port)

Deprecated. use RuntimeConfiguration instead

Set port for accessing devtools on localhost

Parameters:

port - port number

setRuntimeAssetsUrl

public void setRuntimeAssetsUrl(String url)

Deprecated. use RuntimeConfiguration instead

Set root URL/URI for the RVM and Runtime assets. This can be a CDN or other server location. RVM and Runtime assets should be served from the following paths:

  url/rvm
  url/runtime
 

Parameters:

url - URL of Runtime assets

addAppAsset

public void addAppAsset(String config)

Deprecated. use RuntimeConfiguration instead

Add a config for app asset

Parameters:

config - config string which must be a valid JSON string

setLogLevel

public void setLogLevel(boolean enabled)

Deprecated.

Set log level to be FINE

Parameters:

enabled - true for enabling DEBUG logging

getChannel

public Channel getChannel(String name)

Get specified channel.

Parameters:

name - Name of the channel

Returns:

Channel object with the given name.