com.goldencode.p2j.ui.client.gui.driver.web

Class WebHtmlBrowser

java.lang.Object

com.goldencode.p2j.ui.client.gui.driver.web.WebDriverWidget

com.goldencode.p2j.ui.client.gui.driver.web.WebHtmlBrowser

All Implemented Interfaces:

DriverWidget

class WebHtmlBrowser
extends WebDriverWidget

Web driver implementation of the HTML-BROWSER widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	WebHtmlBrowser.Handler Handler implementation to allow hooking up navigation events.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	effectiveContextPath The effective context path
private java.lang.String	effectiveResourceBase The effective resource base
private java.lang.String	generatedContextPath The context-path which was generated based on a whitelisted entry
private java.net.URI	generatedResourceBase The resource-base which was generated based on a whitelisted entry
private org.eclipse.jetty.server.handler.ContextHandler	handler The custom handler for hooking up navigation events
private static java.lang.String	HTML_MIME_TYPE Default mime type
private boolean	injectDriver Driver injection flag.
private static CentralLogger	LOG logger
static java.lang.String	P2J_HTMLBROWSER_DRIVER_JS Name of the driver js file
static java.lang.String	PARENT_ORIGIN Parent-origin token
private static java.lang.String	pwd Process work dir
private static java.nio.charset.Charset	UTF8 UTF-8 charset

Fields inherited from class com.goldencode.p2j.ui.client.gui.driver.web.WebDriverWidget

visible, websock, widgetId, window

Constructor Summary

Constructors

Constructor and Description
WebHtmlBrowser(int widgetId, GuiWebSocket websock) Initialize the web component.

Method Summary

Modifier and Type	Method and Description
private org.apache.tika.metadata.Metadata	autodetectContent(java.io.InputStream is) Runs autodetection on the content represented by input stream.
void	destroy() Destroy the driver-specific widget.
private java.lang.String	getContextPath() Retrieve a context path specific for this web browser.
private java.lang.String	getResourceBase() Retrieve a resource base specific for this web browser.
private java.util.Map.Entry<java.lang.String,java.net.URI>	getWhitelistEntry(java.net.URI path) Check if a provided path is inside a whitelisted entry.
private void	initHandler(java.lang.String localFile, FileSystem fileSystem) Parse the input resource and if this is an HTML read its base tag.
java.lang.Object	invokeWidgetCommand(java.lang.String command, java.lang.Object[] args) Invokes a command on this widget.
private void	openHTMLString(java.lang.String html) Assigns the supplied string as the html content in the widget.
private boolean	openUrl(java.lang.String urlString) Open the specified URL.
private org.jsoup.nodes.Document	parseHTML(java.io.InputStream in, java.lang.String charset) Attempts to parse the supplied input data as html content.
void	placeWidget(NativeRectangle bounds) Place the driver-specific widget at the specified bounds, using the currently selected window.
private void	resetHandler() This resets the handlers for this browser and should be called when the state of the CONTEXT-PATH or RESOUCE-BASE is changed.
boolean	setWidgetAttribute(java.lang.String attr, java.lang.String val) Set an attribute for a widget implemented at the driver level.
private void	transformHTML(java.io.InputStream inputHTML, java.io.OutputStream outputHTML, java.lang.String charset) The HTML rendered on the Web client should have local hrefs resolved.

Methods inherited from class com.goldencode.p2j.ui.client.gui.driver.web.WebDriverWidget

config, getWindow, setEnabled, setVisible, setWidgetBounds, setWindow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.goldencode.p2j.ui.client.gui.driver.DriverWidget

invokeWidgetCommand

Field Detail

LOG

private static final CentralLogger LOG

logger

UTF8

private static final java.nio.charset.Charset UTF8

UTF-8 charset

HTML_MIME_TYPE

private static final java.lang.String HTML_MIME_TYPE

Default mime type

See Also:

Constant Field Values

PARENT_ORIGIN

public static final java.lang.String PARENT_ORIGIN

Parent-origin token

See Also:

Constant Field Values

P2J_HTMLBROWSER_DRIVER_JS

public static final java.lang.String P2J_HTMLBROWSER_DRIVER_JS

Name of the driver js file

See Also:

Constant Field Values

pwd

private static final java.lang.String pwd

Process work dir

handler

private org.eclipse.jetty.server.handler.ContextHandler handler

The custom handler for hooking up navigation events

generatedContextPath

private java.lang.String generatedContextPath

The context-path which was generated based on a whitelisted entry

generatedResourceBase

private java.net.URI generatedResourceBase

The resource-base which was generated based on a whitelisted entry

injectDriver

private boolean injectDriver

Driver injection flag. ATM the driver JS is not used as there is not a functional requirement that would require it. But I keep the logic around in case new features are needed.

effectiveResourceBase

private java.lang.String effectiveResourceBase

The effective resource base

effectiveContextPath

private java.lang.String effectiveContextPath

The effective context path

Constructor Detail

WebHtmlBrowser

public WebHtmlBrowser(int widgetId,
                      GuiWebSocket websock)

Initialize the web component.

Parameters:

widgetId - The widget's ID.

websock - The web socket.

Method Detail

setWidgetAttribute

public boolean setWidgetAttribute(java.lang.String attr,
                                  java.lang.String val)

Set an attribute for a widget implemented at the driver level. These are custom attributes which have no counterpart at the FWD client side.

This works only for GUI drivers.

Parameters:

attr - The attribute name.

val - The attribute's value.

Returns:

true if setting this attribute completed.

invokeWidgetCommand

public java.lang.Object invokeWidgetCommand(java.lang.String command,
                                            java.lang.Object[] args)

Invokes a command on this widget.

Parameters:

command - The command to invoke.

args - Optional event arguments.

Returns:

the event return value.

placeWidget

public void placeWidget(NativeRectangle bounds)

Place the driver-specific widget at the specified bounds, using the currently selected window.

Specified by:

placeWidget in interface DriverWidget

Overrides:

placeWidget in class WebDriverWidget

Parameters:

bounds - Widget bounds.

destroy

public void destroy()

Destroy the driver-specific widget.

Specified by:

destroy in interface DriverWidget

Overrides:

destroy in class WebDriverWidget

initHandler

private void initHandler(java.lang.String localFile,
                         FileSystem fileSystem)

Parse the input resource and if this is an HTML read its base tag. If the base tag's href is white-listed calculate the effective resource-base and context and the actual base href. The calculated base href will be set in the requested HTML resource in the handler.

Parameters:

localFile - The local file representing the requested resource.

fileSystem - File system resource.

openUrl

private boolean openUrl(java.lang.String urlString)

Open the specified URL.

Parameters:

urlString - The URL to open.

Returns:

true if the open request is successfully passed to JS driver.

openHTMLString

private void openHTMLString(java.lang.String html)

Assigns the supplied string as the html content in the widget.

Parameters:

html - The html string.

autodetectContent

private org.apache.tika.metadata.Metadata autodetectContent(java.io.InputStream is)

Runs autodetection on the content represented by input stream.

Parameters:

is - The stream to autodetect.

Returns:

Metadata filled with detection result, namely Metadata.CONTENT_TYPE and Metadata.CONTENT_ENCODING, @{code null} in case of error.

parseHTML

private org.jsoup.nodes.Document parseHTML(java.io.InputStream in,
                                           java.lang.String charset)

Attempts to parse the supplied input data as html content. If the input is not valid utf-8 encoded html null is returned.

Parameters:

in - The input data.

Returns:

see above.

Throws:

java.io.IOException

transformHTML

private void transformHTML(java.io.InputStream inputHTML,
                           java.io.OutputStream outputHTML,
                           java.lang.String charset)

The HTML rendered on the Web client should have local hrefs resolved. There are many cases in which a local file is referenced. This is not correct, as clients do not have direct access to the file system. Identify the local hrefs and resolve them using the CONTEXT-PATH and RESOURCE-BASE.

Parameters:

inputHTML - The file which contains the input HTML.

outputHTML - The file in which we should dump a HTML with resolved hrefs.

getWhitelistEntry

private java.util.Map.Entry<java.lang.String,java.net.URI> getWhitelistEntry(java.net.URI path)

Check if a provided path is inside a whitelisted entry. If no such entry is found, null is returned. This means that this path can't be made available through Web. Otherwise, a context-path is returned to be mapped to the provided path as it is whitelisted.

Parameters:

path - The path to be checked.

Returns:

null if this path can't be made available through Web. A context-path otherwise.

getContextPath

private java.lang.String getContextPath()

Retrieve a context path specific for this web browser. This either the explicit context-path configuration or a generated one based on the base tag in the used HTML.

Returns:

The context-path specific for this web browser.

getResourceBase

private java.lang.String getResourceBase()

Retrieve a resource base specific for this web browser. This either the explicit resource-base configuration or a generated one based on the base tag in the used HTML. If no resource-base is given, the method returns the process working directory.

Returns:

The resource-base specific for this web browser. Never null.

resetHandler

private void resetHandler()

This resets the handlers for this browser and should be called when the state of the CONTEXT-PATH or RESOUCE-BASE is changed. This way, the new handler will properly manage the new context path.