org.thales.punch.apps.shiva.worker.impl

Class AbstractWorkerApplication

java.lang.Object

org.thales.punch.apps.shiva.worker.impl.AbstractWorkerApplication

Direct Known Subclasses:

ForkExecWorkerApplication, PlanWorkerApplication

public abstract class AbstractWorkerApplication
extends Object

Shiva applications can be of two types: processes or threads. Most applications are processes. I.e. shiva launche a dedicated process just like any process scheduler.

Punch plans however are lightweight apps that also schedule processes but with an additional templating capabilitiy. Having one dedicated process per plan is overkillm, they basically do nothing but schedule from time to time a spark job. These are represented by threads.

Author:

jonathan

Field Summary

Fields

Modifier and Type	Field and Description
protected org.thales.punch.libraries.shiva.api.Application	application the application descriptor as read from Kafka
protected Path	applicationFolder where are stored the application command and arguments files.
protected String	clusterName The Shiva cluster name of this task
protected Path	confDirFolder The top level directory associasted to this application.
protected boolean	ephemeral True if the application must be executed only once.
protected com.cronutils.model.time.ExecutionTime	executionTime the cron execution time.
protected boolean	hasStarted true if the a start has been issued.
protected Instant	lastExecutionStart the last execution start time.
protected int	numExecution Keep track of the number of time this app has been executed.
protected ApplicationPlatformReporter	platformReporter Contains helpers for logging information
protected String	workerId our worker identifier, used to properly log task traces to elasticsearch

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWorkerApplication(Path applicationFolder, Path confDirFolder, org.thales.punch.libraries.shiva.api.Application application, String clusterName, String workerId)

Method Summary

Modifier and Type	Method and Description
abstract int	exitValue()
org.thales.punch.libraries.shiva.api.Application	getApplication()
String	getClusterName()
Path	getFolder()
String	getName()
String	getWorkerId()
abstract boolean	isAlive()
boolean	isEphemeral()
boolean	isEverRunningTask()
boolean	isStarted()
static org.thales.punch.libraries.forkexec.api.ProcessFuture	launchChildApplication(String workerId, org.thales.punch.libraries.shiva.api.Application application, File home, String confDir, String[] args) Create an environment for the new worker application and launch its subprocess
abstract boolean	start() Start a worker task, i.e.
protected boolean	started() Mark this application as running.
abstract void	stop() Stop a worker task, i.e.
boolean	taskShouldRunNow() An application must start only if : it must run all the time, it must run once and has never be executed yet, or if it is periodic and it's time to fire it.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

applicationFolder

protected final Path applicationFolder

where are stored the application command and arguments files. For example: "/tmp/shiva-worker/tenants_mytenant_channels_mychannel_myapp/tenants/mytenant/channels/mychannel"

confDirFolder

protected final Path confDirFolder

The top level directory associasted to this application. It corresponds to the PUNCHPLATFORM_CONF_DIR variable. We expect to find in there the top level 'tenants' folder.

For example : "/tmp/shiva-worker/tenants_mytenant_channels_mychannel_myapp"

application

protected final org.thales.punch.libraries.shiva.api.Application application

the application descriptor as read from Kafka

clusterName

protected final String clusterName

The Shiva cluster name of this task

workerId

protected final String workerId

our worker identifier, used to properly log task traces to elasticsearch

platformReporter

protected final ApplicationPlatformReporter platformReporter

Contains helpers for logging information

hasStarted

protected boolean hasStarted

true if the a start has been issued.

ephemeral

protected boolean ephemeral

True if the application must be executed only once.

numExecution

protected int numExecution

Keep track of the number of time this app has been executed.

executionTime

protected com.cronutils.model.time.ExecutionTime executionTime

the cron execution time. Null if not a periodic task.

lastExecutionStart

protected Instant lastExecutionStart

the last execution start time.

Constructor Detail

AbstractWorkerApplication

protected AbstractWorkerApplication(Path applicationFolder,
                                    Path confDirFolder,
                                    org.thales.punch.libraries.shiva.api.Application application,
                                    String clusterName,
                                    String workerId)

Method Detail

getName

public String getName()

Returns:

this task name i.e. "punchplatform/mytenant/services/myservice/mycommand"

getApplication

public final org.thales.punch.libraries.shiva.api.Application getApplication()

Returns:

this task application in read only

getClusterName

public String getClusterName()

Returns:

the Shiva cluster name of this task

getWorkerId

public String getWorkerId()

Returns:

the shiva worker id associated to this task

getFolder

public Path getFolder()

Returns:

the folder path

isEverRunningTask

public boolean isEverRunningTask()

Returns:

true if this is an ever running job

isEphemeral

public boolean isEphemeral()

Returns:

true if the application is one shot

isStarted

public boolean isStarted()

Returns:

true if the job has been started. It may or may not bee alive.

isAlive

public abstract boolean isAlive()

Returns:

true if the underlying process is started

start

public abstract boolean start()

Start a worker task, i.e. a child process. This method takes care of reporting errors to logs and reporters.

Returns:

true if it has been started, false in case of failure

Throws:

IOException - in case of issue retrieving arguments

org.thales.punch.exceptions.ConfigurationException

stop

public abstract void stop()

Stop a worker task, i.e. a child process

exitValue

public abstract int exitValue()

Returns:

the process exit value

Throws:

IllegalStateException - if the process has not been started yet, or is still running

toString

public String toString()

Overrides:

toString in class Object

started

protected boolean started()

Mark this application as running. This is a simple helper valid for both threaded and fork exec apps that keep track of the number of executions and the start time.

Returns:

true

launchChildApplication

public static org.thales.punch.libraries.forkexec.api.ProcessFuture launchChildApplication(String workerId,
                                                                                           org.thales.punch.libraries.shiva.api.Application application,
                                                                                           File home,
                                                                                           String confDir,
                                                                                           String[] args)

Create an environment for the new worker application and launch its subprocess

Parameters:

workerId - the worker id launching the application subprocess

application - application the application launched by the worker

home - The working directory of the application

confDir - the punchplatform configuration dir on the shiva worker machine

args - the arguments to launch the application

Returns:

The launched process future object

taskShouldRunNow

public boolean taskShouldRunNow()

An application must start only if : it must run all the time, it must run once and has never be executed yet, or if it is periodic and it's time to fire it.

Returns:

true if the task should run now.