de.hawhamburg.reachability.properties

Interface PropertyServiceNotifiable

All Known Implementing Classes:

ReachabilityWorker

public interface PropertyServiceNotifiable

Required methods for threads to be property service notifiable.

This interfaces defines a list of methods which needs to be implemented by each thread, which would like use a PropertyService and receive notifications from it.

Version:

"2013.42"

Author:

"Malte Kantak <malte.kantak@hotmail.de>"

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getValuesForProperty(java.lang.String property) It may occur that a property is defined as DisplayType.AGENT_DEFINED, which means that the value range is dynamically defined at runtime.
boolean	isSilent() The PropertyService checks if its creator is running in silent mode, which means the method checks if the component is running in an active process state due to the living place agent life cycle specification.
java.util.Properties	loadCurrentProperties(ConfigType propertiesType) The PropertyService requests the actual properties of a certain ConfigType from its creator.
void	updateProperties(java.util.Properties newProperties, java.util.Properties changedProperties, ConfigType propertiesType) The PropertyService informs its creator, that there was a change of properties and that the creator should update his properties according to the new ones.

Method Detail

updateProperties

void updateProperties(java.util.Properties newProperties,
                    java.util.Properties changedProperties,
                    ConfigType propertiesType)

The PropertyService informs its creator, that there was a change of properties and that the creator should update his properties according to the new ones.

Parameters:

newProperties - The list of new Properties.

changedProperties - The list of changed Properties.

propertiesType - The type of properties as ConfigType.

loadCurrentProperties

java.util.Properties loadCurrentProperties(ConfigType propertiesType)

The PropertyService requests the actual properties of a certain ConfigType from its creator. The creator should reload its local property set and return them to the PropertyService.

Parameters:

propertiesType - The ConfigType for which the properties shall be loaded.

Returns:

The loaded properties as Properties.

isSilent

boolean isSilent()

The PropertyService checks if its creator is running in silent mode, which means the method checks if the component is running in an active process state due to the living place agent life cycle specification.

Returns:

true if the component isn't active, otherwise false.

getValuesForProperty

java.util.Map<java.lang.String,java.lang.String> getValuesForProperty(java.lang.String property)

It may occur that a property is defined as DisplayType.AGENT_DEFINED, which means that the value range is dynamically defined at runtime. In this case, the PropertyService asks its creator about the current value range of this property by using this method.

Parameters:

property - The name of the property with dynamic value range as String for which the current value range is requested.

Returns:

The actual value range as Map of String (value) to String (display name).