com.google.gwt.dev.shell.remoteui

Class RemoteUI

java.lang.Object

com.google.gwt.dev.ui.DevModeUI

com.google.gwt.dev.shell.remoteui.RemoteUI

All Implemented Interfaces:

MessageTransport.ErrorCallback

public class RemoteUI
extends DevModeUI
implements MessageTransport.ErrorCallback

An implementation of a UI for the development mode server that sends UI events over the network to a remote viewer. Also receives commands from the remote viewer (such as a web server restart) and forwards the requests to the development mode server.

Constructor Summary

Constructors

Constructor and Description
RemoteUI(String host, int port, String clientId)

Method Summary

Modifier and Type	Method and Description
ModuleHandle	getModuleLogger(String userAgent, String remoteSocket, String url, String tabKey, String moduleName, String sessionKey, String agentTag, byte[] agentIcon, TreeLogger.Type logLevel) Show that a module is loaded in the UI.
TreeLogger	getWebServerLogger(String serverName, byte[] serverIcon) Create the web server portion of the UI if not already created, and return its TreeLogger instance.
void	moduleLoadComplete(boolean success) Indicates that all modules have been loaded (loading the XML, not completing onModuleLoad), and that URLs previously specified in DevModeUI.setStartupUrls(Map) may be launched if successful.
void	onResponseException(Exception e) Called when an exception occurs when attempting to send a response message.
void	onTermination(Exception e) Called when the transport terminates due to an exception.
boolean	restartWebServer()
void	setStartupUrls(Map<String,URL> urls) Set the URLs that should be available to start.

Methods inherited from class com.google.gwt.dev.ui.DevModeUI

getCallback, getConsoleLogger, getLogLevel, getTopLogger, hasCallback, initialize, setCallback, setWebServerSecure

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, toString

Constructor Detail

RemoteUI

public RemoteUI(String host,
                int port,
                String clientId)

Method Detail

getModuleLogger

public ModuleHandle getModuleLogger(String userAgent,
                                    String remoteSocket,
                                    String url,
                                    String tabKey,
                                    String moduleName,
                                    String sessionKey,
                                    String agentTag,
                                    byte[] agentIcon,
                                    TreeLogger.Type logLevel)

Description copied from class: DevModeUI

Show that a module is loaded in the UI.

Note that the CloseModuleEvent should already have a callback registered when this is called if needed -- the UI is not required to change the UI if it is registered later.

Specified by:

getModuleLogger in class DevModeUI

Parameters:

userAgent - full user agent name

remoteSocket - name of remote socket endpoint in host:port format

url - URL of top-level window

tabKey - stable browser tab identifier, or the empty string if no such identifier is available

moduleName - the name of the module loaded

sessionKey - a unique session key

agentTag - short-form user agent identifier, suitable for use in a label for this connection

agentIcon - icon to use for the user agent (fits inside 24x24) or null if unavailable

logLevel - logging detail requested

Returns:

a handle to the module

getWebServerLogger

public TreeLogger getWebServerLogger(String serverName,
                                     byte[] serverIcon)

Description copied from class: DevModeUI

Create the web server portion of the UI if not already created, and return its TreeLogger instance.

Note that the RestartServerEvent should already have a callback registered when this is called -- the UI is not required to change the UI if it is registered later.

Specified by:

getWebServerLogger in class DevModeUI

Parameters:

serverName - short name of the web server or null if only the icon should be used

serverIcon - byte array containing an icon (fitting into 24x24) to use for the server, or null if only the name should be used

Returns:

TreeLogger instance

moduleLoadComplete

public void moduleLoadComplete(boolean success)

Description copied from class: DevModeUI

Indicates that all modules have been loaded (loading the XML, not completing onModuleLoad), and that URLs previously specified in DevModeUI.setStartupUrls(Map) may be launched if successful.

Overrides:

moduleLoadComplete in class DevModeUI

Parameters:

success - true if all modules were successfully loaded

onResponseException

public void onResponseException(Exception e)

Description copied from interface: MessageTransport.ErrorCallback

Called when an exception occurs when attempting to send a response message.

Specified by:

onResponseException in interface MessageTransport.ErrorCallback

onTermination

public void onTermination(Exception e)

Description copied from interface: MessageTransport.ErrorCallback

Called when the transport terminates due to an exception.

Specified by:

onTermination in interface MessageTransport.ErrorCallback

Parameters:

e - The exception that led to the termination

restartWebServer

public boolean restartWebServer()

setStartupUrls

public void setStartupUrls(Map<String,URL> urls)

Description copied from class: DevModeUI

Set the URLs that should be available to start.

Overrides:

setStartupUrls in class DevModeUI

Parameters:

urls - map of URLs -- the key is the name supplied with -startupUrls, and the value is the mapped URL with all parameters included