Package org.openhab.core.config.core.status

Class ConfigStatusService

java.lang.Object

org.openhab.core.config.core.status.ConfigStatusService

All Implemented Interfaces:

ConfigStatusCallback

@NonNullByDefault
public final class ConfigStatusService
extends Object
implements ConfigStatusCallback

The ConfigStatusService provides the ConfigStatusInfo for a specific entity. For this purpose it loops over all registered ConfigStatusProviders and returns the ConfigStatusInfo for the matching ConfigStatusProvider.

Author:

Thomas Höfer - Initial contribution, Chris Jackson - Allow null messages, Markus Rathgeb - Add locale provider support

Constructor Summary

Constructors

Constructor	Description
ConfigStatusService(EventPublisher eventPublisher, LocaleProvider localeProvider, TranslationProvider i18nProvider, BundleResolver bundleResolver)

Method Summary

Modifier and Type	Method	Description
protected void	addConfigStatusProvider(ConfigStatusProvider configStatusProvider)
void	configUpdated(ConfigStatusSource configStatusSource)	Based on the given ConfigStatusSource this operation propagates a new configuration status for an entity after its configuration has been updated.
@Nullable ConfigStatusInfo	getConfigStatus(String entityId, @Nullable Locale locale)	Retrieves the ConfigStatusInfo of the entity by using the registered ConfigStatusProvider that supports the given entity.
protected void	removeConfigStatusProvider(ConfigStatusProvider configStatusProvider)

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigStatusService

public ConfigStatusService(EventPublisher eventPublisher,
 LocaleProvider localeProvider,
 TranslationProvider i18nProvider,
 BundleResolver bundleResolver)

Method Details

getConfigStatus

public @Nullable ConfigStatusInfo getConfigStatus(String entityId,
 @Nullable Locale locale)

Retrieves the ConfigStatusInfo of the entity by using the registered ConfigStatusProvider that supports the given entity.

Parameters:

entityId - the id of the entity whose configuration status information is to be retrieved (must not be null or empty)

locale - the locale to be used for the corresponding configuration status messages; if null then the default local will be used

Returns:

the ConfigStatusInfo or null if there is no ConfigStatusProvider registered that supports the given entity

Throws:

IllegalArgumentException - if given entityId is null or empty

configUpdated

public void configUpdated(ConfigStatusSource configStatusSource)

Description copied from interface: ConfigStatusCallback

Based on the given ConfigStatusSource this operation propagates a new configuration status for an entity after its configuration has been updated.

Specified by:

configUpdated in interface ConfigStatusCallback

Parameters:

configStatusSource - the source of the configuration status

addConfigStatusProvider

protected void addConfigStatusProvider(ConfigStatusProvider configStatusProvider)

removeConfigStatusProvider

protected void removeConfigStatusProvider(ConfigStatusProvider configStatusProvider)