cz.ues.platform.commons.pcb.monitor

Interface UESProcessMonitor

All Known Subinterfaces:

UESProcessMonitor

@UESComponent
public interface UESProcessMonitor

Process Monitor is component used for monitoring of processes by explicit call of methods providing invocation of various notifications (e.g. notification in application log, activity, etc.) and thus providing information about process state and work progress.

Since:

UES6-00

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MONITOR_DISABLED Name of parameter used for disabling of process monitoring.
static int	UNKNOWN Constant used to define unknown units (amount of work).

Method Summary

Methods

Modifier and Type	Method and Description
void	beginProcess(int aTotalUnits, MessageCode aMsgCode, java.lang.String aMsg, java.lang.Object... aParams) Invocation of method marks process as started.
void	done(UESExitState aExitState, MessageCode aMsgCode, java.lang.String aMsg, java.lang.Exception aException, java.lang.Object... aParams) Invocation of method marks process as done.
void	notifyInfo(MessageCode aMsgCode, java.lang.String aMsg, java.lang.Object... aParams) Invokes information notification.
void	notifyWarning(MessageCode aMsgCode, java.lang.String aMsg, java.lang.Object... aParams) Invokes warning notification.
void	progress(int aUnits, MessageCode aMsgCode, java.lang.String aMsg, java.lang.Object... aParams) Informs about process progress (e.g. inside loops or after block of code performing particular operation).
void	setProperties(java.util.Properties aProperties) Provides ability to configure process monitor and all plugged monitor providers using given properties.

Field Detail

UNKNOWN

static final UNKNOWN

Constant used to define unknown units (amount of work).

See Also:

Constant Field Values

MONITOR_DISABLED

static final MONITOR_DISABLED

Name of parameter used for disabling of process monitoring.

See Also:

Constant Field Values

Method Detail

setProperties

void setProperties(java.util.Properties aProperties)

Provides ability to configure process monitor and all plugged monitor providers using given properties. Calling of this method is optional. If properties are not provided default values are used. It is possible to call this method anytime, but since given configuration is usually stored on process context, it is good practice to invoke this method only once in each forked process.

Parameters:

aProperties - Process monitor configuration

Since:

UES6-00

beginProcess

void beginProcess(int aTotalUnits,
MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Object... aParams)

Invocation of method marks process as started. Do not mistake this operation with physical start of process. This method is invoked from "user" block of code to be able to track its progress (e.g. content of script). This method should be paired with call of UESProcessMonitor.done(cz.ues.platform.commons.pcb.monitor.UESExitState, cz.ues.platform.essentials.message.MessageCode, java.lang.String, java.lang.Exception, java.lang.Object...) which should be finally invoked. Once "done" is called, it is not possible to call "beginProcess" once more in same physical process.

Parameters:

aTotalUnits - Total units (amount of work) to be done.

aMsgCode - Code of message used for notification

aMsg - Notification message

aParams - Parameters of notification message

Since:

UES6-00

progress

void progress(int aUnits,
MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Object... aParams)

Informs about process progress (e.g. inside loops or after block of code performing particular operation).

Parameters:

aUnits - Increment of processed units (units processed from beginning in case of first call of progress method, or from last call of progress method)

aMsgCode - Code of message used for notification

aMsg - Notification message

aParams - Parameters of notification message

Since:

UES6-00

notifyInfo

void notifyInfo(MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Object... aParams)

Invokes information notification. Do not mistake this operation with logger. Based on plugged monitoring providers this method may invoke more complex business logic having negative influence of application performance. Therefore method should be used only to inform about more serious events.

Parameters:

aMsgCode - Code of message used for notification

aMsg - Notification message

aParams - Parameters of notification message

Since:

UES6-00

notifyWarning

void notifyWarning(MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Object... aParams)

Invokes warning notification. Do not mistake this operation with logger. Based on plugged monitoring providers this method may invoke more complex business logic having negative influence of application performance. Therefore method should be used only to warn inform about more serious events.

Parameters:

aMsgCode - Code of message used for notification

aMsg - Notification message

aParams - Parameters of notification message

Since:

UES6-00

done

void done(UESExitState aExitState,
MessageCode aMsgCode,
java.lang.String aMsg,
java.lang.Exception aException,
java.lang.Object... aParams)

Invocation of method marks process as done. Do not mistake this operation with physical end of process. This method is invoked from "user" block of code to be able to notify its ending. Based on result of particular operations in this "user code", process may end in various states (resulting in various possible notifications based on plugged monitor providers). Once method is invoked, call of any other method from Process Monitor is ignored (these attempts are however traced) in same physical process.

Parameters:

aExitState - State representing result of finished process

aMsgCode - Code of message used for notification

aMsg - Notification message

aException - Instance of exception which caused process to be finished in FAILED or WARNING state. Parameter may be null which is also expected (not required) value for OK exit state.

aParams - Parameters of notification message

Since:

UES6-00