Package de.aristaflow.adept2.core.client

Interface RemoteExecutionClientService

All Superinterfaces:

ADEPT2Service, CapabilityChecker, ClientService, RemoteClient, WorklistClientService

All Known Subinterfaces:

ADEPT2ClientService

All Known Implementing Classes:

MultiplexingClientService

public interface RemoteExecutionClientService
extends WorklistClientService

This client service extends a worklist client service by the means to execute activities remotely.

Author:

Ulrich Kreher

See Also:

• ExecutionClientService

Nested Class Summary

Nested classes/interfaces inherited from interface de.aristaflow.adept2.core.client.ClientService

ClientService.ActiveAgentChangedListener, ClientService.ServiceStateListener

Method Summary

Modifier and Type	Method	Description
RemoteGUIManager	getRemoteGUIManager()	Gets the GUI manager for creating local GUI contexts for the GUI contexts that are transferred from a remotely executed activity.
Pair<SynchronousActivityStarting,Boolean>	getRemoteSynchronousActivityStarting(EBPInstanceReference activity)	Gets the interface for (synchronous) start operations of the designated activity independently from the execution manager holding the activity and the local runtime manager.

Methods inherited from interface de.aristaflow.adept2.base.service.ADEPT2Service

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

Methods inherited from interface de.aristaflow.adept2.base.sessionmanagement.CapabilityChecker

hasAllCapabilities, hasAllTopLevelCapabilities, hasOneCapability, hasOneTopLevelCapability

Methods inherited from interface de.aristaflow.adept2.core.client.ClientService

addActiveAgentListener, addGUIListener, addServiceStateListener, agentsChanged, connectAll, disconnectAll, getActiveAgent, getActiveClientSessionFactory, getAuthenticatedAgents, getAuthentication, getAvailableLocales, getClusterName, getExecutorService, getFilterFactory, getFormatterFactory, getLicenceManager, getLocalisationFactory, getScheduledExecutorService, getSessionToken, getSessionToken, getSessionToken, getSessionToken, guiSelectionChanged, isConnected, logoff, removeActiveAgentListener, removeGUIListener, removeServiceStateListener, setActiveAgent, setAuthenticatedAgents

Methods inherited from interface de.aristaflow.adept2.core.client.RemoteClient

getDefaultCharset, getDefaultLocale, getJavaVersion, getLoggedOnAgents, getOperatingSystemArchitecture, getOperatingSystemName, getOperatingSystemVersion, getRuntimeManagerURIs, getUsedLocale, ping, serverReturned, serverShutdown

Methods inherited from interface de.aristaflow.adept2.core.client.WorklistClientService

getActivityStarting, getAutoStartRuntimeManager, getExecutionControlManager, getExecutionFactory, getInstanceControl, getOrgModelManager, getProcessManager, getResModelExplorer, getRuntimeManager, getRuntimeService, getSynchronousActivityStarting, getWorklistManager, getWorklistModelFactory

Method Details

getRemoteSynchronousActivityStarting

Pair<SynchronousActivityStarting,Boolean> getRemoteSynchronousActivityStarting(EBPInstanceReference activity)
                                                                        throws ServiceNotKnownException

Gets the interface for (synchronous) start operations of the designated activity independently from the execution manager holding the activity and the local runtime manager. This is similar to WorklistClientService.getSynchronousActivityStarting(EBPInstanceReference) but allows implementations to choose a specific runtime manager. For instance it may be desired to execute all HTML-activities on a specific central runtime manager.
This is a convenience method for getRuntimeManager().getSynchronousActivityStarting() for a specific runtime manager. It may only be called when online.

This method needs not be implemented and may return null! In this case use WorklistClientService.getActivityStarting(EBPInstanceReference).

Parameters:

activity - The activity for which to retrieve the corresponding (synchronous) start interface of the appropriate runtime manager.

Returns:

An interface allowing to perform (synchronous) start operations on the designated activity and whether this refers to a remote activity starting. In this case the corresponding GUI has to be registered appropriately since the remote runtime manager cannot register it at the local client.

Throws:

ServiceNotKnownException - If the runtime manager for the designated activity cannot be retrieved, a ServiceNotKnownException will be thrown.

See Also:

• RuntimeManager.getSynchronousActivityStarting()

getRemoteGUIManager

RemoteGUIManager getRemoteGUIManager()
                              throws ServiceNotKnownException

Gets the GUI manager for creating local GUI contexts for the GUI contexts that are transferred from a remotely executed activity. This GUI manager creates an appropriate local GUI context and usually handles the closing of this local GUI context which depends on the state of the remotely executed activity.

Returns:

The GUI manager for creating local GUI contexts the GUI contexts that are transferred from a remotely executed activity.

Throws:

ServiceNotKnownException - If no remote GUI manager is available for this client, a ServicNotKnownException will be thrown. Usually this indicates a wrong configuration or the normal GUI manager of this client being unable to provide such local GUI contexts for remotely executed activities.