Interface ConfigStatusProvider
- All Known Implementing Classes:
ConfigStatusBridgeHandler
,ConfigStatusThingHandler
@NonNullByDefault
public interface ConfigStatusProvider
The
ConfigStatusProvider
can be implemented and registered as an OSGi service to provide status
information for Configuration
s of entities. The ConfigStatusService
tracks each
ConfigStatusProvider
and provides the corresponding ConfigStatusInfo
by the operation
ConfigStatusService.getConfigStatus(String, Locale)
.- Author:
- Thomas Höfer - Initial contribution
-
Method Summary
Modifier and TypeMethodDescriptionReturns the configuration status in form of a collection ofConfigStatusMessage
s for theConfiguration
of the entity that is supported by thisConfigStatusProvider
.void
setConfigStatusCallback
(@Nullable ConfigStatusCallback configStatusCallback) Sets the givenConfigStatusCallback
for theConfigStatusProvider
.boolean
supportsEntity
(String entityId) Determines if theConfigStatusProvider
instance can provide the configuration status information for the given entity.
-
Method Details
-
getConfigStatus
Collection<ConfigStatusMessage> getConfigStatus()Returns the configuration status in form of a collection ofConfigStatusMessage
s for theConfiguration
of the entity that is supported by thisConfigStatusProvider
.- Returns:
- the requested configuration status (not null)
-
supportsEntity
Determines if theConfigStatusProvider
instance can provide the configuration status information for the given entity.- Parameters:
entityId
- the id of the entity whose configuration status information is to be provided- Returns:
- true, if the
ConfigStatusProvider
instance supports the given entity, otherwise false
-
setConfigStatusCallback
Sets the givenConfigStatusCallback
for theConfigStatusProvider
.- Parameters:
configStatusCallback
- the configuration status callback to be set
-