org.apache.samza.runtime

Interface ApplicationRunner

@InterfaceStability.Evolving
public interface ApplicationRunner

The primary means of managing execution of the SamzaApplication at runtime.

Implementation Notes: implementation of ApplicationRunner must have a public default constructor #ApplicationRunner(SamzaApplication, Config)

Method Summary

Modifier and Type	Method and Description
void	kill() Kill the Samza jobs represented by SamzaApplication It is non-blocking so it doesn't wait for the application stopping.
default void	run() This is like run(ExternalContext), except it provides a null ExternalContext.
void	run(ExternalContext externalContext) Deploy and run the Samza jobs to execute SamzaApplication.
ApplicationStatus	status() Get the collective status of the Samza jobs represented by SamzaApplication.
void	waitForFinish() Waits until the application finishes.
boolean	waitForFinish(java.time.Duration timeout) Waits for timeout duration for the application to finish.

Method Detail

run

default void run()

This is like run(ExternalContext), except it provides a null ExternalContext.

run

void run(ExternalContext externalContext)

Deploy and run the Samza jobs to execute SamzaApplication. It is non-blocking so it doesn't wait for the application running.

Parameters:

externalContext - nullable ExternalContext to pass through to the application

kill

void kill()

Kill the Samza jobs represented by SamzaApplication It is non-blocking so it doesn't wait for the application stopping.

status

ApplicationStatus status()

Get the collective status of the Samza jobs represented by SamzaApplication. Returns ApplicationStatus object.

Returns:

the current status of an instance of SamzaApplication

waitForFinish

void waitForFinish()

Waits until the application finishes.

waitForFinish

boolean waitForFinish(java.time.Duration timeout)

Waits for timeout duration for the application to finish.

Parameters:

timeout - time to wait for the application to finish

Returns:

true - application finished before timeout false - otherwise