flux.jmx
Class FluxEngineManagerForJmx

java.lang.Object
  flux.jmx.FluxEngineManagerForJmx

All Implemented Interfaces:

FluxEngineManagerForJmxMBean

public class FluxEngineManagerForJmx
extends java.lang.Object
implements FluxEngineManagerForJmxMBean

A JMX MBean for managing a Flux engine.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Constructor Summary

FluxEngineManagerForJmx()

Method Summary

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 propertiesFile) 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 propertiesFile) 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

FluxEngineManagerForJmx

public FluxEngineManagerForJmx()

Method Detail

createFluxEngineFromConfigurationFile

public java.lang.String createFluxEngineFromConfigurationFile(java.lang.String propertiesFile)

Description copied from interface: FluxEngineManagerForJmxMBean

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.

Specified by:

createFluxEngineFromConfigurationFile in interface FluxEngineManagerForJmxMBean

Parameters:

propertiesFile - A Flux configuration file.

Returns:

A result message indicating success or failure.

disposeFluxEngine

public java.lang.String disposeFluxEngine()

Description copied from interface: FluxEngineManagerForJmxMBean

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.

Specified by:

disposeFluxEngine in interface FluxEngineManagerForJmxMBean

Returns:

A result message indicating success or failure.

checkIfFluxEngineIsRunning

public java.lang.String checkIfFluxEngineIsRunning()

Description copied from interface: FluxEngineManagerForJmxMBean

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

Specified by:

checkIfFluxEngineIsRunning in interface FluxEngineManagerForJmxMBean

Returns:

A result message indicating success or failure.

lookupRemoteFluxEngineFromConfigurationFile

public java.lang.String lookupRemoteFluxEngineFromConfigurationFile(java.lang.String propertiesFile)

Description copied from interface: FluxEngineManagerForJmxMBean

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.

Specified by:

lookupRemoteFluxEngineFromConfigurationFile in interface FluxEngineManagerForJmxMBean

Parameters:

propertiesFile - A Flux configuration file.

Returns:

A result message indicating success or failure.

startFluxEngine

public java.lang.String startFluxEngine()

Description copied from interface: FluxEngineManagerForJmxMBean

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.

Specified by:

startFluxEngine in interface FluxEngineManagerForJmxMBean

Returns:

A result message indicating success or failure.

stopFluxEngine

public java.lang.String stopFluxEngine()

Description copied from interface: FluxEngineManagerForJmxMBean

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.

Specified by:

stopFluxEngine in interface FluxEngineManagerForJmxMBean

Returns:

A result message indicating success or failure.