com.opera.core.systems.scope

Class ScopeServices

java.lang.Object

com.opera.core.systems.scope.ScopeServices

All Implemented Interfaces:

ConnectionHandler

public class ScopeServices
extends Object
implements ConnectionHandler

Implements the interface to the Scope protocol.

Constructor Summary

Constructors

Constructor and Description
ScopeServices(SortedSet<ScopeService> requiredServices, int port, boolean manualConnect) Creates the Scope server on specified address and port, as well as enabling the required Scope services.

Method Summary

Methods

Modifier and Type	Method and Description
void	captureOperaIdle() Enables the capturing on OperaIdle events.
void	close() Close the connection and cleanup the channel
void	enableServices(Collection<Service> services)
UmsProtos.Response	executeMessage(Message message, com.google.protobuf.AbstractMessage.Builder<?> builder) Sends a message and wait for the response.
UmsProtos.Response	executeMessage(Message message, com.google.protobuf.AbstractMessage.Builder<?> builder, long timeout)
Map<ScopeService,String>	getAvailableServices()
StpConnection	getConnection()
ConsoleLogger	getConsoleLogger()
CookieManager	getCookieManager()
Core	getCore()
Debugger	getDebugger()
DesktopUtils	getDesktopUtils()
DesktopWindowManager	getDesktopWindowManager()
Exec	getExec()
Prefs	getPrefs()
Selftest	getSelftest()
ScopeSystemInputManager	getSystemInputManager()
WindowManager	getWindowManager()
void	init() Gets the supported services from Opera and calls methods to enable the ones we requested.
boolean	isConnected()
boolean	isOperaIdleAvailable()
boolean	onConnected(StpConnection con) This event is emitted if the STP connection thread has accepted a connection.
void	onDesktopWindowActivated(DesktopWmProtos.DesktopWindowInfo info)
void	onDesktopWindowClosed(DesktopWmProtos.DesktopWindowInfo info)
void	onDesktopWindowLoaded(DesktopWmProtos.DesktopWindowInfo info)
void	onDesktopWindowPageChanged(DesktopWmProtos.DesktopWindowInfo info)
void	onDesktopWindowShown(DesktopWmProtos.DesktopWindowInfo info)
void	onDesktopWindowUpdated(DesktopWmProtos.DesktopWindowInfo info)
void	onDisconnect() This event is triggered whenever the STP connection is closed.
void	onException(Exception exception) This event is triggered if an exception is thrown on the STP connection thread.
void	onHandshake(boolean stp1) This event is triggered when we have received a response to StpConnection.sendEnableStp1().
void	onOperaIdle()
void	onQuickMenuClosed(DesktopWmProtos.QuickMenuID id)
void	onQuickMenuItemPressed(DesktopWmProtos.QuickMenuItemID menuItemID)
void	onQuickMenuShown(DesktopWmProtos.QuickMenuInfo info)
void	onRequest(int windowId)
void	onResponseReceived(int tag, UmsProtos.Response response) This event is triggered whenever a command error response is received.
void	onSelftestDone()
void	onServiceList(List<String> services) This event is triggered upon receiving an initial service list from Opera.
void	onWindowClosed(int id)
void	onWindowLoaded(int id)
void	quit()
void	quit(OperaRunner runner)
void	quitOpera(OperaRunner runner)
void	setConsoleLogger(ConsoleLogger consoleLogger)
void	setCookieManager(CookieManager cookieManager)
void	setCore(Core core)
void	setDebugger(EcmascriptDebugger debugger)
void	setDesktopUtils(DesktopUtils desktopUtils)
void	setDesktopWindowManager(DesktopWindowManager desktopWindowManager)
void	setExec(Exec exec)
void	setPrefs(Prefs prefs)
void	setSelftest(Selftest selftest)
void	setSystemInputManager(ScopeSystemInputManager manager)
void	setWindowManager(WindowManager windowManager)
void	shutdown()
void	startStpThread()
WaitState	waitFor()
int	waitForDesktopWindowActivated(String windowName, long timeout)
int	waitForDesktopWindowClosed(String windowName, long timeout)
int	waitForDesktopWindowLoaded(String windowName, long timeout)
int	waitForDesktopWindowPageChanged(String windowName, long timeout)
int	waitForDesktopWindowShown(String windowName, long timeout)
int	waitForDesktopWindowUpdated(String windowName, long timeout)
String	waitForMenuClosed(String menuName, long timeout)
String	waitForMenuItemPressed(String menuItemText, long timeout)
String	waitForMenuShown(String menuName, long timeout)
void	waitForOperaIdle(long timeout) Waits for an OperaIdle event before continuing.
void	waitForWindowLoaded(int activeWindowId, long timeout)
void	waitStart()

Methods inherited from class java.lang.Object

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

Constructor Detail

ScopeServices

public ScopeServices(SortedSet<ScopeService> requiredServices,
             int port,
             boolean manualConnect)
              throws IOException

Creates the Scope server on specified address and port, as well as enabling the required Scope services.

Parameters:

requiredServices - set of required services

port - the port on which to start the Scope server

manualConnect - whether to output ready message with port number when starting

Throws:

IOException - if an I/O error occurs

Method Detail

init

public void init()

Gets the supported services from Opera and calls methods to enable the ones we requested.

isConnected

public boolean isConnected()

shutdown

public void shutdown()

enableServices

public void enableServices(Collection<Service> services)

quitOpera

public void quitOpera(OperaRunner runner)
               throws IOException

Throws:

IOException

getAvailableServices

public Map<ScopeService,String> getAvailableServices()

quit

public void quit()
          throws IOException

Throws:

IOException

quit

public void quit(OperaRunner runner)
          throws IOException

Throws:

IOException

onConnected

public boolean onConnected(StpConnection con)

Description copied from interface: ConnectionHandler

This event is emitted if the STP connection thread has accepted a connection. If an STP connection has already been accepted the return value can be used to close the newly accepted connection.

Specified by:

onConnected in interface ConnectionHandler

Parameters:

con - the connection that has been accepted

Returns:

false if the connection should be closed immediately, or true to continue

onServiceList

public void onServiceList(List<String> services)

Description copied from interface: ConnectionHandler

This event is triggered upon receiving an initial service list from Opera.

Specified by:

onServiceList in interface ConnectionHandler

Parameters:

services - the list of services available in the connected Opera instance

onWindowLoaded

public void onWindowLoaded(int id)

onWindowClosed

public void onWindowClosed(int id)

onDesktopWindowShown

public void onDesktopWindowShown(DesktopWmProtos.DesktopWindowInfo info)

onDesktopWindowUpdated

public void onDesktopWindowUpdated(DesktopWmProtos.DesktopWindowInfo info)

onDesktopWindowClosed

public void onDesktopWindowClosed(DesktopWmProtos.DesktopWindowInfo info)

onDesktopWindowActivated

public void onDesktopWindowActivated(DesktopWmProtos.DesktopWindowInfo info)

onDesktopWindowLoaded

public void onDesktopWindowLoaded(DesktopWmProtos.DesktopWindowInfo info)

onDesktopWindowPageChanged

public void onDesktopWindowPageChanged(DesktopWmProtos.DesktopWindowInfo info)

onQuickMenuShown

public void onQuickMenuShown(DesktopWmProtos.QuickMenuInfo info)

onQuickMenuItemPressed

public void onQuickMenuItemPressed(DesktopWmProtos.QuickMenuItemID menuItemID)

onQuickMenuClosed

public void onQuickMenuClosed(DesktopWmProtos.QuickMenuID id)

onHandshake

public void onHandshake(boolean stp1)

Description copied from interface: ConnectionHandler

This event is triggered when we have received a response to StpConnection.sendEnableStp1().

Specified by:

onHandshake in interface ConnectionHandler

Parameters:

stp1 - true if handshake was an STP/1 response

onDisconnect

public void onDisconnect()

Description copied from interface: ConnectionHandler

This event is triggered whenever the STP connection is closed.

Specified by:

onDisconnect in interface ConnectionHandler

onOperaIdle

public void onOperaIdle()

onSelftestDone

public void onSelftestDone()

waitForWindowLoaded

public void waitForWindowLoaded(int activeWindowId,
                       long timeout)

waitFor

public WaitState waitFor()

isOperaIdleAvailable

public boolean isOperaIdleAvailable()

captureOperaIdle

public void captureOperaIdle()

Enables the capturing on OperaIdle events. Sometimes when executing a command OperaIdle events will fire before the response is received for the sent command. This results in missing the Idle events, and later probably hitting a timeout. To prevent this you can call this function which will enable the tracking of any Idle events received between now and when you call waitForOperaIdle(). If Idle events have been received then waitForOperaIdle() will return immediately.

waitForOperaIdle

public void waitForOperaIdle(long timeout)

Waits for an OperaIdle event before continuing. If captureOperaIdle() has been called since the last call of waitForOperaIdle(), and one or more OperaIdle events have occurred then this function will return immediately. After calling this function the capturing of OperaIdle events is disabled until the next call of captureOperaIdle()

Parameters:

timeout - Time in milliseconds to wait before aborting

waitStart

public void waitStart()

waitForDesktopWindowLoaded

public int waitForDesktopWindowLoaded(String windowName,
                             long timeout)

waitForDesktopWindowShown

public int waitForDesktopWindowShown(String windowName,
                            long timeout)

waitForDesktopWindowUpdated

public int waitForDesktopWindowUpdated(String windowName,
                              long timeout)

waitForDesktopWindowActivated

public int waitForDesktopWindowActivated(String windowName,
                                long timeout)

waitForDesktopWindowClosed

public int waitForDesktopWindowClosed(String windowName,
                             long timeout)

waitForDesktopWindowPageChanged

public int waitForDesktopWindowPageChanged(String windowName,
                                  long timeout)

waitForMenuShown

public String waitForMenuShown(String menuName,
                      long timeout)

waitForMenuClosed

public String waitForMenuClosed(String menuName,
                       long timeout)

waitForMenuItemPressed

public String waitForMenuItemPressed(String menuItemText,
                            long timeout)

onResponseReceived

public void onResponseReceived(int tag,
                      UmsProtos.Response response)

Description copied from interface: ConnectionHandler

This event is triggered whenever a command error response is received.

Specified by:

onResponseReceived in interface ConnectionHandler

Parameters:

tag - the internal command tag corresponding to the request

response - the response, or null if the response was an error

onException

public void onException(Exception exception)

Description copied from interface: ConnectionHandler

This event is triggered if an exception is thrown on the STP connection thread. Once this event has been triggered then the STP connection should be considered closed, and no further read/write operations are allowed.

Specified by:

onException in interface ConnectionHandler

Parameters:

exception - the exception thrown on the STP connection thread

close

public void close()

Close the connection and cleanup the channel

executeMessage

public UmsProtos.Response executeMessage(Message message,
                                com.google.protobuf.AbstractMessage.Builder<?> builder)

Sends a message and wait for the response.

executeMessage

public UmsProtos.Response executeMessage(Message message,
                                com.google.protobuf.AbstractMessage.Builder<?> builder,
                                long timeout)

startStpThread

public void startStpThread()

onRequest

public void onRequest(int windowId)

getConnection

public StpConnection getConnection()

getDebugger

public Debugger getDebugger()

setDebugger

public void setDebugger(EcmascriptDebugger debugger)

getExec

public Exec getExec()

setExec

public void setExec(Exec exec)

getWindowManager

public WindowManager getWindowManager()

setWindowManager

public void setWindowManager(WindowManager windowManager)

getConsoleLogger

public ConsoleLogger getConsoleLogger()

setConsoleLogger

public void setConsoleLogger(ConsoleLogger consoleLogger)

getCore

public Core getCore()

setCore

public void setCore(Core core)

getPrefs

public Prefs getPrefs()

setPrefs

public void setPrefs(Prefs prefs)

getDesktopWindowManager

public DesktopWindowManager getDesktopWindowManager()

setDesktopWindowManager

public void setDesktopWindowManager(DesktopWindowManager desktopWindowManager)

getDesktopUtils

public DesktopUtils getDesktopUtils()

setDesktopUtils

public void setDesktopUtils(DesktopUtils desktopUtils)

getSystemInputManager

public ScopeSystemInputManager getSystemInputManager()

setSystemInputManager

public void setSystemInputManager(ScopeSystemInputManager manager)

getCookieManager

public CookieManager getCookieManager()

setCookieManager

public void setCookieManager(CookieManager cookieManager)

getSelftest

public Selftest getSelftest()

setSelftest

public void setSelftest(Selftest selftest)