forked from openhab/openhab-core
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor ThingHandlerService to an OSGi component prototype (openhab#…
…3957) Also-by: Connor Petty <mistercpp2000+gitsignoff@gmail.com> Signed-off-by: J-N-K <github@klug.nrw> Signed-off-by: Ciprian Pascu <contact@ciprianpascu.ro>
- Loading branch information
Showing
23 changed files
with
331 additions
and
100 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
129 changes: 129 additions & 0 deletions
129
...src/main/java/org/openhab/core/config/discovery/AbstractThingHandlerDiscoveryService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,129 @@ | ||
| /** | ||
| * Copyright (c) 2010-2023 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.core.config.discovery; | ||
|
|
||
| import java.util.Map; | ||
| import java.util.Set; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNull; | ||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.openhab.core.config.core.ConfigParser; | ||
| import org.openhab.core.thing.ThingTypeUID; | ||
| import org.openhab.core.thing.binding.ThingHandler; | ||
| import org.openhab.core.thing.binding.ThingHandlerService; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * The {@link AbstractThingHandlerDiscoveryService} extends the {@link AbstractDiscoveryService} for thing-based | ||
| * discovery services. | ||
| * | ||
| * It handles the injection of the {@link ThingHandler} | ||
| * | ||
| * @author Jan N. Klug - Initial contribution | ||
| */ | ||
| @NonNullByDefault | ||
| public abstract class AbstractThingHandlerDiscoveryService<T extends ThingHandler> extends AbstractDiscoveryService | ||
| implements ThingHandlerService { | ||
| private final Logger logger = LoggerFactory.getLogger(AbstractThingHandlerDiscoveryService.class); | ||
| private final Class<T> thingClazz; | ||
| private boolean backgroundDiscoveryEnabled = false; | ||
|
|
||
| // this works around a bug in ecj: @NonNullByDefault({}) complains about the field not being | ||
| // initialized when the type is generic, so we have to initialize it with "something" | ||
| protected @NonNullByDefault({}) T thingHandler = (@NonNull T) null; | ||
|
|
||
| protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz, @Nullable Set<ThingTypeUID> supportedThingTypes, | ||
| int timeout, boolean backgroundDiscoveryEnabledByDefault) throws IllegalArgumentException { | ||
| super(supportedThingTypes, timeout, backgroundDiscoveryEnabledByDefault); | ||
| this.thingClazz = thingClazz; | ||
| } | ||
|
|
||
| protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz, @Nullable Set<ThingTypeUID> supportedThingTypes, | ||
| int timeout) throws IllegalArgumentException { | ||
| super(supportedThingTypes, timeout); | ||
| this.thingClazz = thingClazz; | ||
| } | ||
|
|
||
| protected AbstractThingHandlerDiscoveryService(Class<T> thingClazz, int timeout) throws IllegalArgumentException { | ||
| super(timeout); | ||
| this.thingClazz = thingClazz; | ||
| } | ||
|
|
||
| @Override | ||
| protected abstract void startScan(); | ||
|
|
||
| @Override | ||
| @SuppressWarnings("unchecked") | ||
| public void setThingHandler(ThingHandler handler) { | ||
| if (thingClazz.isAssignableFrom(handler.getClass())) { | ||
| this.thingHandler = (T) handler; | ||
| } else { | ||
| throw new IllegalArgumentException( | ||
| "Expected class is " + thingClazz + " but the parameter has class " + handler.getClass()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public @Nullable ThingHandler getThingHandler() { | ||
| return thingHandler; | ||
| } | ||
|
|
||
| @Override | ||
| public void activate(@Nullable Map<String, Object> config) { | ||
| // do not call super.activate here, otherwise the scan might be background scan might be started before the | ||
| // thing handler is set. This is correctly handled in initialize | ||
| if (config != null) { | ||
| backgroundDiscoveryEnabled = ConfigParser.valueAsOrElse( | ||
| config.get(DiscoveryService.CONFIG_PROPERTY_BACKGROUND_DISCOVERY), Boolean.class, false); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void modified(@Nullable Map<String, Object> config) { | ||
| if (config != null) { | ||
| boolean enabled = ConfigParser.valueAsOrElse( | ||
| config.get(DiscoveryService.CONFIG_PROPERTY_BACKGROUND_DISCOVERY), Boolean.class, false); | ||
|
|
||
| if (backgroundDiscoveryEnabled && !enabled) { | ||
| stopBackgroundDiscovery(); | ||
| logger.debug("Background discovery for discovery service '{}' disabled.", getClass().getName()); | ||
| } else if (!backgroundDiscoveryEnabled && enabled) { | ||
| startBackgroundDiscovery(); | ||
| logger.debug("Background discovery for discovery service '{}' enabled.", getClass().getName()); | ||
| } | ||
| backgroundDiscoveryEnabled = enabled; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void deactivate() { | ||
| // do not call super.deactivate here, background scan is already handled in dispose | ||
| } | ||
|
|
||
| @Override | ||
| public void initialize() { | ||
| if (backgroundDiscoveryEnabled) { | ||
| startBackgroundDiscovery(); | ||
| logger.debug("Background discovery for discovery service '{}' enabled.", getClass().getName()); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void dispose() { | ||
| if (backgroundDiscoveryEnabled) { | ||
| stopBackgroundDiscovery(); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.