Package org.eso.ias.kafkautils

Class KafkaHelper

java.lang.Object

org.eso.ias.kafkautils.KafkaHelper

public class KafkaHelper
extends Object

A helper class providing useful methods and constants for Kafka

Author:

acaproni

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROKERS_PROPNAME	The name of the property to get the list of kafka servers
static final String	CMD_TOPIC_NAME	The name of the kafka topic for commands
static final String	CONSUMER_GROUP_PROPNAME	The name of the property to get the name of the consumer group
static final String	DEFAULT_BOOTSTRAP_BROKERS	Default list of servers
static final String	DEFAULT_CONSUMER_GROUP	The kafka group to which this consumer belongs
static final String	HEARTBEAT_TOPIC_NAME	The name of the kafka topic where tools publish the heartbeat
static final String	IASIOs_TOPIC_NAME	The name of the kafka topic where converters and DASUs push the IASIOs
static final String	PLUGINS_TOPIC_NAME	The topic used by plugins to send monitor point values and alarms to the converter
static final String	REPLY_TOPIC_NAME	The name of the kafka topic for replies

Constructor Summary

Constructors

Constructor	Description
KafkaHelper()

Method Summary

Modifier and Type	Method	Description
String	getValue(String propName, String defaultValue)	Get the value of a property from the system properties
String	getValue(Properties userProps, String propName, String defaultValue)	Get the value of a property from the passed properties or, if not found from the System properties.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_BOOTSTRAP_BROKERS

public static final String DEFAULT_BOOTSTRAP_BROKERS

Default list of servers

See Also:

• Constant Field Values

BROKERS_PROPNAME

public static final String BROKERS_PROPNAME

The name of the property to get the list of kafka servers

See Also:

• Constant Field Values

DEFAULT_CONSUMER_GROUP

public static final String DEFAULT_CONSUMER_GROUP

The kafka group to which this consumer belongs

See Also:

• Constant Field Values

CONSUMER_GROUP_PROPNAME

public static final String CONSUMER_GROUP_PROPNAME

The name of the property to get the name of the consumer group

See Also:

• Constant Field Values

PLUGINS_TOPIC_NAME

public static final String PLUGINS_TOPIC_NAME

The topic used by plugins to send monitor point values and alarms to the converter

See Also:

• Constant Field Values

IASIOs_TOPIC_NAME

public static final String IASIOs_TOPIC_NAME

The name of the kafka topic where converters and DASUs push the IASIOs

See Also:

• Constant Field Values

HEARTBEAT_TOPIC_NAME

public static final String HEARTBEAT_TOPIC_NAME

The name of the kafka topic where tools publish the heartbeat

See Also:

• Constant Field Values

CMD_TOPIC_NAME

public static final String CMD_TOPIC_NAME

The name of the kafka topic for commands

See Also:

• Constant Field Values

REPLY_TOPIC_NAME

public static final String REPLY_TOPIC_NAME

The name of the kafka topic for replies

See Also:

• Constant Field Values

Constructor Details

KafkaHelper

public KafkaHelper()

Method Details

getValue

public String getValue(String propName,
 String defaultValue)

Get the value of a property from the system properties

Parameters:

propName - the name of the property whose value must be get from the system properties

defaultValue - the default value if the property is not defined

Returns:

the value of the property

getValue

public String getValue(Properties userProps,
 String propName,
 String defaultValue)

Get the value of a property from the passed properties or, if not found from the System properties. If the value is not found in both properties sets then the default is returned.

Parameters:

userProps - the user defined properties

propName - the name of the property to retrieve

defaultValue - the default value if the property is not found

Returns:

the value of the property