Package org.openhab.core.config.discovery

Class AbstractThingHandlerDiscoveryService<T extends ThingHandler>

java.lang.Object

org.openhab.core.config.discovery.AbstractDiscoveryService

org.openhab.core.config.discovery.AbstractThingHandlerDiscoveryService<T>

All Implemented Interfaces:

DiscoveryService, ThingHandlerService

@NonNullByDefault
public abstract class AbstractThingHandlerDiscoveryService<T extends ThingHandler>
extends AbstractDiscoveryService
implements ThingHandlerService

The AbstractThingHandlerDiscoveryService extends the AbstractDiscoveryService for thing-based discovery services. It handles the injection of the ThingHandler

Author:

Jan N. Klug - Initial contribution, Laurent Garnier - Added discovery with an optional input parameter

Field Summary

Fields

Modifier and Type	Field	Description
protected T	thingHandler

Fields inherited from class org.openhab.core.config.discovery.AbstractDiscoveryService

i18nProvider, localeProvider, scanListener, scheduler

Fields inherited from interface org.openhab.core.config.discovery.DiscoveryService

CONFIG_PROPERTY_BACKGROUND_DISCOVERY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractThingHandlerDiscoveryService(Class<T> thingClazz, int timeout)	Creates a new instance of this class with the specified parameters and with scanInputLabel and scanInputDescription set to null, without any supportedThingTypes, and backgroundDiscoveryEnabledByDefault enabled.
protected	AbstractThingHandlerDiscoveryService(Class<T> thingClazz, @Nullable Set<ThingTypeUID> supportedThingTypes, int timeout)	Creates a new instance of this class with the specified parameters and with scanInputLabel and scanInputDescription set to null, and backgroundDiscoveryEnabledByDefault enabled.
protected	AbstractThingHandlerDiscoveryService(Class<T> thingClazz, @Nullable Set<ThingTypeUID> supportedThingTypes, int timeout, boolean backgroundDiscoveryEnabledByDefault)	Creates a new instance of this class with the specified parameters and with scanInputLabel and scanInputDescription set to null.
protected	AbstractThingHandlerDiscoveryService(Class<T> thingClazz, @Nullable Set<ThingTypeUID> supportedThingTypes, int timeout, boolean backgroundDiscoveryEnabledByDefault, @Nullable String scanInputLabel, @Nullable String scanInputDescription)	Creates a new instance of this class with the specified parameters.
protected	AbstractThingHandlerDiscoveryService(ScheduledExecutorService scheduler, Class<T> thingClazz, @Nullable Set<ThingTypeUID> supportedThingTypes, int timeout, boolean backgroundDiscoveryEnabledByDefault, @Nullable String scanInputLabel, @Nullable String scanInputDescription)	Creates a new instance of this class with the specified parameters.

Method Summary

Modifier and Type	Method	Description
void	activate(@Nullable Map<String,Object> config)	Called on component activation, if the implementation of this class is an OSGi declarative service and does not override the method.
void	deactivate()	Called on component deactivation, if the implementation of this class is an OSGi declarative service and does not override the method.
void	dispose()	This method is used by the framework during de-activation of the service.
@Nullable T	getThingHandler()	Gets the ThingHandler on which the actions (methods) should be called
void	initialize()	This method is used by the framework during activation of the service.
void	modified(@Nullable Map<String,Object> config)	Called when the configuration for the discovery service is changed.
void	setThingHandler(ThingHandler handler)	Sets the ThingHandler on which the actions (methods) should be called
protected abstract void	startScan()	This method is called by the AbstractDiscoveryService.startScan(ScanListener) implementation of the AbstractDiscoveryService.

Methods inherited from class org.openhab.core.config.discovery.AbstractDiscoveryService

abortScan, addDiscoveryListener, getLocalizedDiscoveryResult, getScanInputDescription, getScanInputLabel, getScanTimeout, getSupportedThingTypes, getTimestampOfLastScan, isBackgroundDiscoveryEnabled, isScanInputSupported, removeDiscoveryListener, removeOlderResults, removeOlderResults, removeOlderResults, startBackgroundDiscovery, startScan, startScan, startScan, stopBackgroundDiscovery, stopScan, thingDiscovered, thingRemoved

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openhab.core.thing.binding.ThingHandlerService

activate

Field Details

thingHandler

@NonNullByDefault({})
protected T extends ThingHandler thingHandler

Constructor Details

AbstractThingHandlerDiscoveryService

protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz,
 @Nullable Set<ThingTypeUID> supportedThingTypes,
 int timeout,
 boolean backgroundDiscoveryEnabledByDefault,
 @Nullable String scanInputLabel,
 @Nullable String scanInputDescription)
                                        throws IllegalArgumentException

Creates a new instance of this class with the specified parameters.

Parameters:

thingClazz - the ThingHandler class.

supportedThingTypes - the list of Thing types which are supported (can be null).

timeout - the discovery timeout in seconds after which the discovery service automatically stops its forced discovery process (>= 0).

backgroundDiscoveryEnabledByDefault - defines, whether the default for this discovery service is to enable background discovery or not.

scanInputLabel - the label of the optional input parameter to start the discovery or null if no input parameter supported.

scanInputDescription - the description of the optional input parameter to start the discovery or null if no input parameter supported.

Throws:

IllegalArgumentException - if timeout < 0.

AbstractThingHandlerDiscoveryService

protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz,
 @Nullable Set<ThingTypeUID> supportedThingTypes,
 int timeout,
 boolean backgroundDiscoveryEnabledByDefault)
                                        throws IllegalArgumentException

Creates a new instance of this class with the specified parameters and with scanInputLabel and scanInputDescription set to null.

Parameters:

thingClazz - the ThingHandler class.

supportedThingTypes - the list of Thing types which are supported (can be null).

timeout - the discovery timeout in seconds after which the discovery service automatically stops its forced discovery process (>= 0).

backgroundDiscoveryEnabledByDefault - defines, whether the default for this discovery service is to enable background discovery or not.

Throws:

IllegalArgumentException - if timeout < 0.

AbstractThingHandlerDiscoveryService

protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz,
 @Nullable Set<ThingTypeUID> supportedThingTypes,
 int timeout)
                                        throws IllegalArgumentException

Creates a new instance of this class with the specified parameters and with scanInputLabel and scanInputDescription set to null, and backgroundDiscoveryEnabledByDefault enabled.

Parameters:

thingClazz - the ThingHandler class.

supportedThingTypes - the list of Thing types which are supported (can be null).

timeout - the discovery timeout in seconds after which the discovery service automatically stops its forced discovery process (>= 0).

Throws:

IllegalArgumentException - if timeout < 0.

AbstractThingHandlerDiscoveryService

protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz,
 int timeout)
                                        throws IllegalArgumentException

Creates a new instance of this class with the specified parameters and with scanInputLabel and scanInputDescription set to null, without any supportedThingTypes, and backgroundDiscoveryEnabledByDefault enabled.

Parameters:

thingClazz - the ThingHandler class.

timeout - the discovery timeout in seconds after which the discovery service automatically stops its forced discovery process (>= 0).

Throws:

IllegalArgumentException - if timeout < 0.

AbstractThingHandlerDiscoveryService

protected AbstractThingHandlerDiscoveryService(ScheduledExecutorService scheduler,
 Class<T> thingClazz,
 @Nullable Set<ThingTypeUID> supportedThingTypes,
 int timeout,
 boolean backgroundDiscoveryEnabledByDefault,
 @Nullable String scanInputLabel,
 @Nullable String scanInputDescription)
                                        throws IllegalArgumentException

Creates a new instance of this class with the specified parameters.

For use by tests only, allows setting a different ScheduledExecutorService like SameThreadExecutorService for synchronous behavior during testing.

Parameters:

thingClazz - the ThingHandler class.

supportedThingTypes - the list of Thing types which are supported (can be null).

timeout - the discovery timeout in seconds after which the discovery service automatically stops its forced discovery process (>= 0).

backgroundDiscoveryEnabledByDefault - defines, whether the default for this discovery service is to enable background discovery or not.

scanInputLabel - the label of the optional input parameter to start the discovery or null if no input parameter supported.

scanInputDescription - the description of the optional input parameter to start the discovery or null if no input parameter supported.

Throws:

IllegalArgumentException - if timeout < 0.

Method Details

startScan

protected abstract void startScan()

Description copied from class: AbstractDiscoveryService

This method is called by the AbstractDiscoveryService.startScan(ScanListener) implementation of the AbstractDiscoveryService. The abstract class schedules a call of AbstractDiscoveryService.stopScan() after AbstractDiscoveryService.getScanTimeout() seconds. If this behavior is not appropriate, the AbstractDiscoveryService.startScan(ScanListener) method should be overridden.

Specified by:

startScan in class AbstractDiscoveryService

setThingHandler

public void setThingHandler(ThingHandler handler)

Description copied from interface: ThingHandlerService

Sets the ThingHandler on which the actions (methods) should be called

Specified by:

setThingHandler in interface ThingHandlerService

Parameters:

handler - the ThingHandler

getThingHandler

public @Nullable T getThingHandler()

Description copied from interface: ThingHandlerService

Gets the ThingHandler on which the actions (methods) should be called

Specified by:

getThingHandler in interface ThingHandlerService

Returns:

the ThingHandler

activate

public void activate(@Nullable Map<String,Object> config)

Description copied from class: AbstractDiscoveryService

Called on component activation, if the implementation of this class is an OSGi declarative service and does not override the method. The method implementation calls AbstractDiscoveryService.startBackgroundDiscovery() if background discovery is enabled by default and not overridden by the configuration.

Overrides:

activate in class AbstractDiscoveryService

Parameters:

config - configuration properties

modified

public void modified(@Nullable Map<String,Object> config)

Description copied from class: AbstractDiscoveryService

Called when the configuration for the discovery service is changed. If background discovery should be enabled and is currently disabled, the method AbstractDiscoveryService.startBackgroundDiscovery() is called. If background discovery should be disabled and is currently enabled, the method AbstractDiscoveryService.stopBackgroundDiscovery() is called. In all other cases, nothing happens.

Overrides:

modified in class AbstractDiscoveryService

Parameters:

config - configuration properties

deactivate

public void deactivate()

Description copied from class: AbstractDiscoveryService

Called on component deactivation, if the implementation of this class is an OSGi declarative service and does not override the method. The method implementation calls AbstractDiscoveryService.stopBackgroundDiscovery() if background discovery is enabled at the time of component deactivation.

Specified by:

deactivate in interface ThingHandlerService

Overrides:

deactivate in class AbstractDiscoveryService

initialize

public void initialize()

Description copied from interface: ThingHandlerService

This method is used by the framework during activation of the service. It is called AFTER the component is fully activated and thing handler has been set. Implementations should override this method to add additional initialization code. This method should call super.initialize() to ensure background discovery is properly handled. See ThingHandlerService.activate(), ThingHandlerService.dispose()

Specified by:

initialize in interface ThingHandlerService

dispose

public void dispose()

Description copied from interface: ThingHandlerService

This method is used by the framework during de-activation of the service. It is called while the component is still activated. Code depending on an activated service should go here. This method should call super.dispose() to ensure background discovery is properly handled. See ThingHandlerService.deactivate(), ThingHandlerService.initialize()

Specified by:

dispose in interface ThingHandlerService