org.rvpf.valve

Class Controller

Object

Controller

All Implemented Interfaces:

ServiceThread.Target

public final class Controller
extends Object
implements ServiceThread.Target

Controller.

Instances of this class are used by services to control a Valve. Where the Valve is configured by its own properties file, this class get its configuration from its creator configuration. Since more than one Valve may be configured, all the informations needed to complete the connection to the control port are supplied in a properties group.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTROL_ADDRESS_PROPERTY Specifies the interface and port listening for the control of the valve.
static ElapsedTime	DEFAULT_RETRY_DELAY Default retry delay.
static String	REQUIRED_PROPERTY Indicates that a successful connection to the control port of the valve is required for this service to complete its initialization.
static String	RETRY_DELAY_PROPERTY The elapsed time before retrying to connect.
static String	RETRY_PROPERTY Requests retries for a successful connection.

Constructor Summary

Constructors

Constructor and Description
Controller(Config config) Constructs an instance.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this controller.
boolean	open(String propertiesName) Opens a control connection to a valve.
void	run() Runs.

Methods inherited from class Object

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

Field Detail

CONTROL_ADDRESS_PROPERTY

public static final String CONTROL_ADDRESS_PROPERTY

Specifies the interface and port listening for the control of the valve. It must have the form "interface:port" (without the quotes).

See Also:

Constant Field Values

DEFAULT_RETRY_DELAY

public static final ElapsedTime DEFAULT_RETRY_DELAY

Default retry delay.

REQUIRED_PROPERTY

public static final String REQUIRED_PROPERTY

Indicates that a successful connection to the control port of the valve is required for this service to complete its initialization.

See Also:

Constant Field Values

RETRY_DELAY_PROPERTY

public static final String RETRY_DELAY_PROPERTY

The elapsed time before retrying to connect.

See Also:

Constant Field Values

RETRY_PROPERTY

public static final String RETRY_PROPERTY

Requests retries for a successful connection.

See Also:

Constant Field Values

Constructor Detail

Controller

public Controller(@Nonnull
                  Config config)

Constructs an instance.

Parameters:

config - The config.

Method Detail

close

public void close()

Closes this controller.

open

@CheckReturnValue
public boolean open(@Nonnull
                                       String propertiesName)

Opens a control connection to a valve.

Parameters:

propertiesName - The name of a group of properties.

Returns:

True on success.

run

public void run()

Runs.

Similar to same in Runnable but may throw exceptions.

Specified by:

run in interface ServiceThread.Target