flux.jmx

Interface FluxEngineManagerForJmxMBean

All Known Implementing Classes:

FluxEngineManagerForJmx

public interface FluxEngineManagerForJmxMBean

The interface to a JMX MBean for managing a Flux engine.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkIfFluxEngineIsRunning() Indicates whether the Flux engine has been started and is ready to execute flow charts.
java.lang.String	createFluxEngineFromConfigurationFile(java.lang.String configurationFile) Creates a Flux engine using a configuration file.
java.lang.String	disposeFluxEngine() Disposes the Flux engine instance that was previously created or looked up.
java.lang.String	lookupRemoteFluxEngineFromConfigurationFile(java.lang.String configurationFile) Looks up a remote Flux Flux engine using a configuration file.
java.lang.String	startFluxEngine() Starts the Flux engine that was previously created or looked up.
java.lang.String	stopFluxEngine() Stops the Flux engine that was previously created or looked up.

Method Detail

createFluxEngineFromConfigurationFile

java.lang.String createFluxEngineFromConfigurationFile(java.lang.String configurationFile)

Creates a Flux engine using a configuration file. Eventually, this instance must be disposed from this JMX MBean. A second Flux engine instance cannot be created or looked up until after the Flux engine instance created by this method is disposed.

Parameters:

configurationFile - A Flux configuration file.

Returns:

A result message indicating success or failure.

disposeFluxEngine

java.lang.String disposeFluxEngine()

Disposes the Flux engine instance that was previously created or looked up. Note that a Flux engine that was looked up does not need to be disposed by this JMX MBean, because a looked up instance may be disposed by another client.

Returns:

A result message indicating success or failure.

checkIfFluxEngineIsRunning

java.lang.String checkIfFluxEngineIsRunning()

Indicates whether the Flux engine has been started and is ready to execute flow charts.

Returns:

A result message indicating success or failure.

lookupRemoteFluxEngineFromConfigurationFile

java.lang.String lookupRemoteFluxEngineFromConfigurationFile(java.lang.String configurationFile)

Looks up a remote Flux Flux engine using a configuration file. This instance does not need to be disposed by this JMX MBean, because a looked up instance may be disposed by another client.

Parameters:

configurationFile - A Flux configuration file.

Returns:

A result message indicating success or failure.

startFluxEngine

java.lang.String startFluxEngine()

Starts the Flux engine that was previously created or looked up. Note that a Flux engine that was looked up does not need to be started by this JMX MBean, because the looked up instance may already be started or may be started by another client.

Returns:

A result message indicating success or failure.

stopFluxEngine

java.lang.String stopFluxEngine()

Stops the Flux engine that was previously created or looked up. Note that a Flux engine that was looked up does not need to be stopped by this JMX MBean, because the looked up instance may already be stoppped or may be stopped by another client.

Returns:

A result message indicating success or failure.