ee.telekom.workflow.core.common

Class WorkflowEngineConfiguration

java.lang.Object

ee.telekom.workflow.core.common.WorkflowEngineConfiguration

@Component
public class WorkflowEngineConfiguration
extends Object

Provides a common place to access configuration parameters.

Also provides default parameters for some of the values.

Author:

Christian Klock

Constructor Summary

Constructors

Constructor and Description
WorkflowEngineConfiguration()

Method Summary

Modifier and Type	Method and Description
String	getClusterHazelcastName() This parameter is used as the Hazelcast instance bean name.
String	getClusterMulticastGroup() This parameter is used for Hazelcasts cluster member auto-detection and defaults to Hacelcasts multicast group default "224.2.2.3".
int	getClusterMulticastPort() This parameter is used for Hazelcasts cluster member auto-detection and defaults to Hacelcasts multicast port default 54327.
int	getClusterMulticastTtl() This parameter is used for Hazelcasts cluster member auto-detection and defaults to 0.
String	getClusterName() This parameter is used as the Hazelcast cluster group name.
String	getConsoleMappingPrefix()
String	getEnvironment() Environment name, will be displayed (when not empty) in web console after application name
int	getHeartbeatInterval() Must be a value less than workflowengine.heartbeat.maximumPauseSeconds. Used as interval in seconds to run health check.
int	getHeartbeatMaximumPauseSeconds() Must be a value greater than workflowengine.heartbeat.intervalSeconds.
int	getMaximumNodeAssignmentTimeSeconds() The maximum time a consumer is granted to update a workflow instance's node_name field after taking a work unit from the queue.
String	getNodeName() This parameter is used as name when indicating which cluster node is currently executing a workflow instance.
int	getNumberOfConsumerThreads() The number of consumer thread started when the engine starts.
String	getPluginApplicationContextFile() The Spring application context file for plugins.
int	getProducerIntervalSeconds() The interval in seconds after which the poller attempts to find new work units.
String	getSchema() Returns the PostgreSQL schema name + "." for workflow engine tables or an empty string if not configured.
void	init()
boolean	isDevelopmentMode() Determines whether the engine is deployed in development mode (as opposed to production).
boolean	isEmbeddedNavigationMode() Determines if the header logo and navigation links act as a stand-alone web app (default), or as embedded web screens.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorkflowEngineConfiguration

public WorkflowEngineConfiguration()

Method Detail

init

@PostConstruct
public void init()

getSchema

public String getSchema()

Returns the PostgreSQL schema name + "." for workflow engine tables or an empty string if not configured. Used for constructing SQL queries.

getClusterHazelcastName

public String getClusterHazelcastName()

This parameter is used as the Hazelcast instance bean name.

getClusterName

public String getClusterName()

This parameter is used as the Hazelcast cluster group name. It is also used to group workflow instances into groups. This leverages several clusters to run against one database (e.g. a cluster for every developer and a test instance and a prelive instance).

getClusterMulticastGroup

public String getClusterMulticastGroup()

This parameter is used for Hazelcasts cluster member auto-detection and defaults to Hacelcasts multicast group default "224.2.2.3".

getClusterMulticastPort

public int getClusterMulticastPort()

This parameter is used for Hazelcasts cluster member auto-detection and defaults to Hacelcasts multicast port default 54327.

getClusterMulticastTtl

public int getClusterMulticastTtl()

This parameter is used for Hazelcasts cluster member auto-detection and defaults to 0. That means that multicast requests are restricted to the same host.

getNodeName

public String getNodeName()

This parameter is used as name when indicating which cluster node is currently executing a workflow instance.

getHeartbeatInterval

public int getHeartbeatInterval()

Must be a value less than workflowengine.heartbeat.maximumPauseSeconds.
Used as interval in seconds to run health check. Update node's heart beat field is to current date (see database table and field node.heartbeat) If master: Refresh locks expire time (sets the lock expire time to current time + workflowengine.heartbeat.maximumPauseSeconds) Find other nodes that are did not have a heartbeat for longer than workflowengine.heartbeat.maximumPauseSeconds and mark their status as failed If slave: Test whether lock has expired and attempt to acquire it If master: Run recovery

getHeartbeatMaximumPauseSeconds

public int getHeartbeatMaximumPauseSeconds()

Must be a value greater than workflowengine.heartbeat.intervalSeconds. Used as interval in seconds to declare a node as FAILED if it is in ENALBED state but did not have a heartbeat in the given interval that the master lock is valid (afterwards it expires)

Returns:

getMaximumNodeAssignmentTimeSeconds

public int getMaximumNodeAssignmentTimeSeconds()

The maximum time a consumer is granted to update a workflow instance's node_name field after taking a work unit from the queue.

getProducerIntervalSeconds

public int getProducerIntervalSeconds()

The interval in seconds after which the poller attempts to find new work units.

getNumberOfConsumerThreads

public int getNumberOfConsumerThreads()

The number of consumer thread started when the engine starts.

getPluginApplicationContextFile

public String getPluginApplicationContextFile()

The Spring application context file for plugins. The context is started when the engine starts and closed when it shuts down. It is used to resolve beans by name during call and callAsync executions, find listeners to engine events, find workflow definitions.

isDevelopmentMode

public boolean isDevelopmentMode()

Determines whether the engine is deployed in development mode (as opposed to production).

getConsoleMappingPrefix

public String getConsoleMappingPrefix()

getEnvironment

public String getEnvironment()

Environment name, will be displayed (when not empty) in web console after application name

isEmbeddedNavigationMode

public boolean isEmbeddedNavigationMode()

Determines if the header logo and navigation links act as a stand-alone web app (default), or as embedded web screens.