de.aristaflow.adept2.ui.htmlgui

Class RemoteHTMLContext

java.lang.Object

de.aristaflow.adept2.ui.htmlgui.AbstractHTMLContext

de.aristaflow.adept2.ui.htmlgui.RemoteHTMLContext

All Implemented Interfaces:

GUIContext, HTMLContext, HTTPReplyHandler, URLContext, java.io.Serializable

public class RemoteHTMLContext
extends AbstractHTMLContext
implements URLContext, java.io.Serializable

A simple HTMLContext that does not create any browsers or alike but just provides the interaction between webserver and ExecutableComponent. Additionally, this context can be serialised to allow for accessing the GUI (HTML) remotely. Since the event handling of a normal HTMLContext prevents serialisation, only the URL is serialised (by replacing this context with a URLContext). This URL can then be called remotely while the interaction between webserver and ExecutableComponent is further handled by this context (instance).

Note that as stated above this context is not really serialisable. When serialising it is replaced by a URLContext which implies that only a URLContext can be deserialised.

Author:

Ulrich Kreher

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface de.aristaflow.adept2.ui.htmlgui.HTMLContext

HTMLContext.Attachment, HTMLContext.HTTPReply, HTMLContext.Response

Field Summary

Fields

Modifier and Type	Field and Description
protected HTTPService	httpService The HTTP service for deregistering this reply handler.
protected SessionToken	session The session token for deregistering at the HTTPService.
protected java.lang.String	sessionID The ID of the session in which the GUI context is needed (required for deregistering this reply handler).
protected TransferredURLContext	urlContext The context for transferring this HTMLContext for remote usage.

Fields inherited from class de.aristaflow.adept2.ui.htmlgui.AbstractHTMLContext

baseURL, DEFAULT_FINAL_RESPONSE, finalResponse, initialContent, logger, replies, replyHandlerTerminated, responses, thread

Constructor Summary

Constructors

Constructor and Description
RemoteHTMLContext(java.lang.Thread thread, SessionToken session, HTTPService httpService, java.lang.String sessionID, ActivityInstance activityInstance, EBPInstanceReference activity, ExecutionContext executionContext) Creates a new HTMLContext for handling the interaction between webserver and ExecutableComponent and also to provide the URL to a client allowing to call the URL remotely.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the GUI for this context.
void	setBaseURL(java.net.URL baseURL) Sets the base URL on which the reply handler is reachable via HTTP.

Methods inherited from class de.aristaflow.adept2.ui.htmlgui.AbstractHTMLContext

checkForValidExecutorThread, getResponse, getURL, getURL, setFinalResponse, setFinalResponse, setInitialContent, setResponse, waitForHTTPReply

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.aristaflow.adept2.ui.htmlgui.URLContext

getURL

Field Detail

session

protected final SessionToken session

The session token for deregistering at the HTTPService. This should be retrieved from the client service instead of reusing the registering token.

httpService

protected final HTTPService httpService

The HTTP service for deregistering this reply handler.

urlContext

protected TransferredURLContext urlContext

The context for transferring this HTMLContext for remote usage. Note that this will not have a URL until setBaseURL(URL) has been called.

sessionID

protected final java.lang.String sessionID

The ID of the session in which the GUI context is needed (required for deregistering this reply handler).

Constructor Detail

RemoteHTMLContext

public RemoteHTMLContext(java.lang.Thread thread,
                         SessionToken session,
                         HTTPService httpService,
                         java.lang.String sessionID,
                         ActivityInstance activityInstance,
                         EBPInstanceReference activity,
                         ExecutionContext executionContext)

Creates a new HTMLContext for handling the interaction between webserver and ExecutableComponent and also to provide the URL to a client allowing to call the URL remotely.

Parameters:

thread - The thread which executes the component using this context (locally).

session - The session token used for deregistering at the HTTPService.

httpService - The HTTPService to deregister this context.

sessionID - The session ID used for deregistering at the HTTPService.

activityInstance - The activity instance this GUI context has been created for.

activity - The EBPInstanceReference identifying the process instance node this GUI context has been created for.

executionContext - The execution context of the activity for which this GUI context has been created for.

Method Detail

close

public void close()

Description copied from interface: GUIContext

Closes the GUI for this context. This method has to be called by the runtime manager whenever an application has terminated (finished, failed, aborted, killed,...).
It must be possible to call this method more than once, even if the GUIContext has already shut down. This especially applies to the disposal of SWT-widgets, that is, it is allowed to call this method after the disposal of the corresponding widgets.

Specified by:

close in interface GUIContext

Specified by:

close in interface HTMLContext

setBaseURL

public void setBaseURL(java.net.URL baseURL)

Description copied from interface: HTTPReplyHandler

Sets the base URL on which the reply handler is reachable via HTTP. Further parameters can be arbitrarily added by the activity, as long as the resulting URL is valid.

Specified by:

setBaseURL in interface HTTPReplyHandler

Overrides:

setBaseURL in class AbstractHTMLContext

Parameters:

baseURL - The URL on which this reply handler is reachable via HTTP.