cz.ues.platform.commons.pcb

Interface UESProcessManager

All Known Subinterfaces:

UESProcessManager

@UESComponent
public interface UESProcessManager

UESProcessManager - for administration of process execution and environment.

Since:

UES6-00

Method Summary

Methods

Modifier and Type	Method and Description
void	exitProcess() Exits active process and sets its parent process as active one.
void	forkProcess() Creates the new child-process for current process and makes it active (all following commands are executed in this child-process).
<T> T	getParameter(java.lang.String aName, java.lang.Class<T> aParamClass) Returns parameter from environment of active process, or from parent process environment if parameter is not present in active active process environment.
void	setParameter(java.lang.String aName, java.lang.Object aValue) Sets local parameter to active process environment.
void	setRetainedParameter(java.lang.String aName, java.lang.Object aValue) Sets parameter to active process environment.

Method Detail

forkProcess

void forkProcess()
throws UESProcessManagerRTException

Creates the new child-process for current process and makes it active (all following commands are executed in this child-process). Block after fork must be ended by exit (to end created child-process and dispose its PCB).

This method can be used to fork either system process or application process. In case system process is forked, new session process ID is associated with this new child-process.

Throws:

UESProcessManagerRTException - In case fork of process failed or fork is not possible

Since:

UES6-00

exitProcess

void exitProcess()
throws UESProcessManagerRTException

Exits active process and sets its parent process as active one. It is not possible to exit root process.

Throws:

UESProcessManagerRTException - In case exit of process failed or exit is not possible

Since:

UES6-00

setParameter

void setParameter(java.lang.String aName,
java.lang.Object aValue)
throws UESProcessManagerRTException

Sets local parameter to active process environment. This parameter will be accessible by active process and all child processes.

Parameters:

aName - Name of parameter. Should be in format system_subsystem_module[_submodule]_parameterName.

aValue - Value of parameter. Value may be null in which case parameter is removed from process environment (does not remove parameter from parent process environment).

Throws:

UESProcessManagerRTException - In case store of parameter fails or store is not possible (e.g. there is already another parameter set under given name but of different type)

Since:

UES6-00

setRetainedParameter

void setRetainedParameter(java.lang.String aName,
java.lang.Object aValue)
throws UESProcessManagerRTException

Sets parameter to active process environment. This parameter will be accessible by active process and all child processes, but also retained when process is serialized (to be able to restore parameter on server side during remote communication or to be used in executed asynchronous jobs).

Parameters:

aName - Name of parameter. Should be in format system_subsystem_module[_submodule]_parameterName.

aValue - Value of parameter. Value may be null in which case parameter is removed from process environment (does not remove parameter from parent process environment).

Throws:

UESProcessManagerRTException - In case store of parameter fails or store is not possible (e.g. there is already another parameter set under given name but of different type)

Since:

UES6-00

getParameter

<T> T getParameter(java.lang.String aName,
java.lang.Class<T> aParamClass)
throws UESProcessManagerRTException

Returns parameter from environment of active process, or from parent process environment if parameter is not present in active active process environment.

Returned parameter should be always handled as immutable. If you need to change some internal value of parameter object, create new parameter object and store it as whole.

Type Parameters:

T - Type of parameter value

Parameters:

aName - Name of parameter

aParamClass - Class of parameter value

Returns:

Value of parameter or null if parameter does not exist

Throws:

UESProcessManagerRTException - In case reading of parameter fails or read is not possible(e.g. given class does not match type of parameter stored under given name)

Since:

UES6-00