Package de.aristaflow.adept2.ui.guimanager

Class RemoteHTMLGUIManager

java.lang.Object

de.aristaflow.adept2.base.service.AbstractADEPT2Service

de.aristaflow.adept2.core.runtimemanager.gui.AbstractGUIManager

de.aristaflow.adept2.ui.guimanager.RemoteHTMLGUIManager

All Implemented Interfaces:

ADEPT2Service, LogService, ServiceThreadHandling, ActivityStateNotification, GUIManager, RemoteGUIManager

public class RemoteHTMLGUIManager
extends AbstractGUIManager

A GUI manager supporting the NullGUIContext and a RemoteHTMLContext as the GUIContext for (nearly) GUI-less clients with a webserver.

Author:

Ulrich Kreher

Nested Class Summary

Nested classes/interfaces inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

AbstractADEPT2Service.ActiveSessions

Field Summary

Fields inherited from class de.aristaflow.adept2.core.runtimemanager.gui.AbstractGUIManager

CONF_TERMINATION_TIMEOUT, earlyTerminates, guiContexts, listeners, TERMINATION_TIMEOUT

Fields inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

CONF_CSV_LOGGING, configuration, logger, registry, runtimeRequiredServices, startupRequiredServices

Constructor Summary

Constructors

Constructor	Description
RemoteHTMLGUIManager(org.apache.commons.configuration2.Configuration configuration, Registry registry)	Instantiate the manager that returns only NullGUIContexts on client requests.

Method Summary

Modifier and Type	Method	Description
protected GUIContext	createRemoteHtmlContext(SessionToken session, ActivityInstance actInst, EBPInstanceReference activity, String sessionId, ExecutionContext execContext, Thread thread, HTTPService httpService)	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.
GUIContext	getGUIContext(SessionToken session, ActivityInstance activityInstance, EBPInstanceReference ebpInstanceReference, String sessionID, ExecutionContext executionContext, ExecutionControlManager ecm, Thread thread)	Gets an appropriate GUI context for the designated activity as configured locally for the corresponding client.

Methods inherited from class de.aristaflow.adept2.core.runtimemanager.gui.AbstractGUIManager

activityClosed, activityFailed, activityReset, activityResumed, activitySignalled, activitySuspended, activitySuspended, closeGUIContext, createGUIContext, getActivityStateListenerURIs, getExecutionControlManager, getLocalForRemoteGuiContext, terminateRemoteExecution

Methods inherited from class de.aristaflow.adept2.base.service.AbstractADEPT2Service

_sessionActive, _sessionFinished, activeOrInvalidServiceStateException, changeLogContext, changeLogContext, changeLogContext, consoleLog, csvLoggingEnabled, getClassSpecificJulLogger, getDependencyRegistry, getLocalUris, getLogger, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, getUserCredentials, init, isActive, isSessionActive, isShutdown, logMethodEntry, logMethodEntry, logMethodEntry, logMethodExit, logMethodExit, ping, preShutdown, privilegeSession, privilegeThread, revertLogContextChanges, sessionActive, sessionActive, sessionActive, sessionActive, sessionFinished, sessionFinished, shutdown, signalShutdown, signalStart, start, unprivilegeThread

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.base.service.ADEPT2Service

getLocalUris, getRelease, getRuntimeRequiredServices, getServiceInstanceName, getStartupRequiredServices, getURIs, init, ping, preShutdown, shutdown, start

Constructor Detail

RemoteHTMLGUIManager

public RemoteHTMLGUIManager(org.apache.commons.configuration2.Configuration configuration,
                            Registry registry)

Instantiate the manager that returns only NullGUIContexts on client requests.

Parameters:

registry - The assigned registry of this GUIManager instance.

configuration - The configuration assigned to this GUIManager instance.

Method Detail

getGUIContext

public GUIContext getGUIContext(SessionToken session,
                                ActivityInstance activityInstance,
                                EBPInstanceReference ebpInstanceReference,
                                String sessionID,
                                ExecutionContext executionContext,
                                ExecutionControlManager ecm,
                                Thread thread)
                         throws GUIContextUnavailableException

Description copied from interface: GUIManager

Gets an appropriate GUI context for the designated activity as configured locally for the corresponding client. This method looks for a specific context for the execution environment of the activity. If none is defined, the context for the type of the activity (for instance, a standard GUI for all web services) will be returned. If there is also no definition, a standard GUI context will be returned.
Applications using the GUI context should cast the returned instance to the appropriate implementation.

Parameters:

session - The session which is used to check for access rights on this method.

activityInstance - The activity instance for which a GUI context is to be retrieved. If a localisation is available, it will already be applied.

ebpInstanceReference - The EBP-instance reference (identifies the corresponding instance node) for which a GUI context is to be retrieved.

sessionID - The ID of the session in which the GUI context is needed.

executionContext - The context in which the component the GUI context is retrieved for is executed.

ecm - A reference to control the execution, for instance, to close the application when the user closes the GUI window of the returned GUI context.

thread - The thread, the component runs inside. The GUI context must check calls to it against this thread, to ensure thread safety.

Returns:

The context containing the appropriate GUI for displaying the user interface of an application.

Throws:

GUIContextUnavailableException - If the requested GUI context can not be created, a GUIContextUnavailableException will be thrown.

createRemoteHtmlContext

protected GUIContext createRemoteHtmlContext(SessionToken session,
                                             ActivityInstance actInst,
                                             EBPInstanceReference activity,
                                             String sessionId,
                                             ExecutionContext execContext,
                                             Thread thread,
                                             HTTPService httpService)

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:

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

actInst - The activity instance to create the GUI context for.

activity - The EBPInstanceReference identifying the process instance node to create the GUI context for.

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

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

execContext - The execution context of the activity for which to create the GUI context.

httpService - The HTTPService to deregister the context.

Returns:

The HTML GUI context with the designated parameters.