Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove deprecated method of 'ConfigOptionProvider' - preparations #8093

Merged
merged 1 commit into from
Jul 9, 2020
Merged

Remove deprecated method of 'ConfigOptionProvider' - preparations #8093

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions ...penhab/binding/amazondashbutton/internal/config/AmazonDashButtonConfigOptionProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,14 @@
import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
import java.util.Set;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.smarthome.config.core.ConfigOptionProvider;
import org.eclipse.smarthome.config.core.ParameterOption;
import org.eclipse.smarthome.core.thing.ThingTypeUID;
Expand All @@ -40,18 +41,25 @@
* @author Oliver Libutzki - Initial contribution
*
*/
@Component(service = ConfigOptionProvider.class, immediate = true)
@Component(service = ConfigOptionProvider.class)
@NonNullByDefault
public class AmazonDashButtonConfigOptionProvider implements ConfigOptionProvider {

@Override
public Collection<ParameterOption> getParameterOptions(URI uri, String param, Locale locale) {
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable Locale locale) {
return getParameterOptions(uri, param, null, locale);
}

@Override
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable String context,
@Nullable Locale locale) {
if ("thing-type".equals(uri.getScheme())) {
ThingTypeUID thingtypeUID = new ThingTypeUID(uri.getSchemeSpecificPart());
if (thingtypeUID.equals(DASH_BUTTON_THING_TYPE) && PROPERTY_NETWORK_INTERFACE_NAME.equals(param)) {
return getPcapNetworkInterfacesOptions();
}
}
return Collections.emptyList();
return null;
}

private Collection<ParameterOption> getPcapNetworkInterfacesOptions() {
Expand Down
92 changes: 41 additions & 51 deletions ...acker/src/main/java/org/openhab/binding/gpstracker/internal/GPSTrackerHandlerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,17 @@
import static org.openhab.binding.gpstracker.internal.GPSTrackerBindingConstants.CONFIG_PID;

import java.net.URI;
import java.util.*;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Locale;
import java.util.Map;
import java.util.Set;

import javax.servlet.ServletException;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.smarthome.config.core.ConfigOptionProvider;
import org.eclipse.smarthome.config.core.ParameterOption;
import org.eclipse.smarthome.core.i18n.LocationProvider;
Expand All @@ -36,6 +43,7 @@
import org.openhab.binding.gpstracker.internal.provider.gpslogger.GPSLoggerCallbackServlet;
import org.openhab.binding.gpstracker.internal.provider.owntracks.OwnTracksCallbackServlet;
import org.osgi.service.component.ComponentContext;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.osgi.service.http.HttpService;
Expand All @@ -49,6 +57,7 @@
* @author Gabor Bicskei - Initial contribution
*/
@Component(configurationPid = CONFIG_PID, service = { ThingHandlerFactory.class, ConfigOptionProvider.class })
@NonNullByDefault
public class GPSTrackerHandlerFactory extends BaseThingHandlerFactory implements TrackerRegistry, ConfigOptionProvider {
/**
* Config URI
Expand All @@ -63,47 +72,58 @@ public class GPSTrackerHandlerFactory extends BaseThingHandlerFactory implements
/**
* Discovery service instance
*/
private TrackerDiscoveryService discoveryService;
private final TrackerDiscoveryService discoveryService;

/**
* Unit provider
*/
private UnitProvider unitProvider;
private final UnitProvider unitProvider;

/**
* Location provider
*/
private LocationProvider locationProvider;
private final LocationProvider locationProvider;

/**
* HTTP service reference
*/
private HttpService httpService;
private final HttpService httpService;

/**
* Endpoint called by tracker applications
*/
private OwnTracksCallbackServlet otHTTPEndpoint;
private @NonNullByDefault({}) OwnTracksCallbackServlet otHTTPEndpoint;

/**
* Endpoint called by tracker applications
*/
private GPSLoggerCallbackServlet glHTTPEndpoint;
private @NonNullByDefault({}) GPSLoggerCallbackServlet glHTTPEndpoint;

/**
* Notification broker
*/
private NotificationBroker notificationBroker = new NotificationBroker();
private final NotificationBroker notificationBroker = new NotificationBroker();

/**
* Handler registry
*/
private Map<String, TrackerHandler> trackerHandlers = new HashMap<>();
private final Map<String, TrackerHandler> trackerHandlers = new HashMap<>();

/**
* All regions.
*/
private Set<String> regions = new HashSet<>();
private final Set<String> regions = new HashSet<>();

@Activate
public GPSTrackerHandlerFactory(final @Reference HttpService httpService, //
final @Reference TrackerDiscoveryService discoveryService, //
final @Reference UnitProvider unitProvider, //
final @Reference LocationProvider locationProvider) {
this.httpService = httpService;
this.discoveryService = discoveryService;
this.unitProvider = unitProvider;
this.locationProvider = locationProvider;
}

/**
* Called by the framework to find out if thing type is supported by the handler factory.
Expand All @@ -123,12 +143,12 @@ public boolean supportsThingType(ThingTypeUID thingTypeUID) {
* @return Handler instance
*/
@Override
protected ThingHandler createHandler(Thing thing) {
protected @Nullable ThingHandler createHandler(Thing thing) {
ThingTypeUID thingTypeUID = thing.getThingTypeUID();
if (GPSTrackerBindingConstants.THING_TYPE_TRACKER.equals(thingTypeUID)
&& ConfigHelper.getTrackerId(thing.getConfiguration()) != null) {
TrackerHandler trackerHandler = new TrackerHandler(thing, notificationBroker, regions,
locationProvider != null ? locationProvider.getLocation() : null, unitProvider);
locationProvider.getLocation(), unitProvider);
discoveryService.removeTracker(trackerHandler.getTrackerId());
trackerHandlers.put(trackerHandler.getTrackerId(), trackerHandler);
return trackerHandler;
Expand Down Expand Up @@ -187,53 +207,23 @@ protected void deactivate(ComponentContext componentContext) {
}

@Override
public Collection<ParameterOption> getParameterOptions(URI uri, String param, Locale locale) {
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable Locale locale) {
return getParameterOptions(uri, param, null, locale);
}

@Override
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable String context,
@Nullable Locale locale) {
if (URI_STR.equals(uri.toString()) && ConfigHelper.CONFIG_REGION_NAME.equals(param)) {
Set<ParameterOption> ret = new HashSet<>();
regions.forEach(r -> ret.add(new ParameterOption(r, r)));
return ret;
}
return Collections.emptyList();
}

@Reference
protected void setHttpService(HttpService httpService) {
this.httpService = httpService;
}

protected void unsetHttpService(HttpService httpService) {
this.httpService = null;
}

@Reference
protected void setTrackerDiscoveryService(TrackerDiscoveryService discoveryService) {
this.discoveryService = discoveryService;
}

protected void unsetTrackerDiscoveryService(TrackerDiscoveryService discoveryService) {
this.discoveryService = null;
}

@Reference
protected void setUnitProvider(UnitProvider unitProvider) {
this.unitProvider = unitProvider;
}

protected void unsetUnitProvider(UnitProvider unitProvider) {
this.unitProvider = null;
}

@Reference
protected void setLocationProvider(LocationProvider locationProvider) {
this.locationProvider = locationProvider;
}

protected void unsetLocationProvider(LocationProvider locationProvider) {
this.locationProvider = null;
return null;
}

@Override
public TrackerHandler getTrackerHandler(String trackerId) {
public @Nullable TrackerHandler getTrackerHandler(String trackerId) {
return trackerHandlers.get(trackerId);
}
}
8 changes: 6 additions & 2 deletions ...acker/src/main/java/org/openhab/binding/gpstracker/internal/provider/TrackerRegistry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,24 @@
*/
package org.openhab.binding.gpstracker.internal.provider;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.gpstracker.internal.handler.TrackerHandler;

/**
* Functional interface for checking tracker registration.
*
* @author Gabor Bicskei - Initial contribution
*/
@NonNullByDefault
public interface TrackerRegistry {

/**
* Returns a handler for a given id
*
*
* @param trackerId the id of the tracker
* @return the handler or null if it does not exist
* @return the handler
*/
@Nullable
TrackerHandler getTrackerHandler(String trackerId);
}
10 changes: 5 additions & 5 deletions ...meter/src/main/java/org/openhab/binding/smartmeter/internal/SmartMeterConfigProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@
* @author Matthias Steigenberger - Initial contribution
*
*/
@Component(service = ConfigOptionProvider.class)
@NonNullByDefault
@Component
public class SmartMeterConfigProvider implements ConfigOptionProvider {

@Override
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable String context,
@Nullable Locale locale) {
return ConfigOptionProvider.super.getParameterOptions(uri, param, context, locale);
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable Locale locale) {
return getParameterOptions(uri, param, null, locale);
}

@Override
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable Locale locale) {
public @Nullable Collection<ParameterOption> getParameterOptions(URI uri, String param, @Nullable String context,
@Nullable Locale locale) {
if (!SmartMeterBindingConstants.THING_TYPE_SMLREADER.getAsString().equals(uri.getSchemeSpecificPart())) {
return null;
}
Expand Down