public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rework ThingActions (#8732)

Browse Source 
* Remove proxy workarounds
* Move ThingActions and a few other classes into the internal package
* Use more consistent action labels/descriptions

Related to:

* openhab/openhab-core#1714
* openhab/openhab-core#1639

Signed-off-by: Wouter Born <github@maindrain.net>
This commit is contained in:
Wouter Born
2020-10-14 19:01:12 +02:00
committed by GitHub
parent 4adc214c69
commit bef1046258
86 changed files with 708 additions and 2096 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/automation/modules/OnkyoThingActions.java
View File

@@ -14,14 +14,58 @@ package org.openhab.binding.onkyo.internal.automation.modules;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.onkyo.internal.handler.OnkyoHandler;
import org.openhab.core.automation.annotation.ActionInput;
import org.openhab.core.automation.annotation.RuleAction;
import org.openhab.core.thing.binding.ThingActions;
import org.openhab.core.thing.binding.ThingActionsScope;
import org.openhab.core.thing.binding.ThingHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* The {@link OnkyoThingActions} defines the interface for all thing actions supported by the binding.
* Some automation actions to be used with a {@link OnkyoThingActions}
*
* @author Laurent Garnier - initial contribution
* @author David Masshardt - initial contribution
*/
@ThingActionsScope(name = "onkyo")
@NonNullByDefault
public interface OnkyoThingActions {
public class OnkyoThingActions implements ThingActions {
public void sendRawCommand(@Nullable String command, @Nullable String value);
private final Logger logger = LoggerFactory.getLogger(OnkyoThingActions.class);
private @Nullable OnkyoHandler handler;
@SuppressWarnings("null")
@RuleAction(label = "send a raw command", description = "Send a raw command to the receiver.")
public void sendRawCommand(@ActionInput(name = "command") @Nullable String command,
@ActionInput(name = "command") @Nullable String value) {
logger.debug("sendRawCommand called with raw command: {} value: {}", command, value);
if (handler == null) {
logger.warn("Onkyo Action service ThingHandler is null!");
return;
}
handler.sendRawCommand(command, value);
}
public static void sendRawCommand(@Nullable ThingActions actions, @Nullable String command,
@Nullable String value) {
if (actions instanceof OnkyoThingActions) {
((OnkyoThingActions) actions).sendRawCommand(command, value);
} else {
throw new IllegalArgumentException("Actions is not an instance of OnkyoThingActions");
}
}
@Override
public void setThingHandler(@Nullable ThingHandler handler) {
if (handler instanceof OnkyoHandler) {
this.handler = (OnkyoHandler) handler;
}
}
@Override
public @Nullable ThingHandler getThingHandler() {
return handler;
}
}

96
bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/automation/modules/OnkyoThingActionsService.java
View File

@@ -1,96 +0,0 @@
/**
* Copyright (c) 2010-2020 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.binding.onkyo.internal.automation.modules;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.openhab.binding.onkyo.internal.handler.OnkyoHandler;
import org.openhab.core.automation.annotation.ActionInput;
import org.openhab.core.automation.annotation.RuleAction;
import org.openhab.core.thing.binding.ThingActions;
import org.openhab.core.thing.binding.ThingActionsScope;
import org.openhab.core.thing.binding.ThingHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Some automation actions to be used with a {@link OnkyoThingActionsService}
* <p>
* <b>Note:</b>The static method <b>invokeMethodOf</b> handles the case where
* the test <i>actions instanceof OnkyoThingActionsService</i> fails. This test can fail
* due to an issue in openHAB core v2.5.0 where the {@link OnkyoThingActionsService} class
* can be loaded by a different classloader than the <i>actions</i> instance.
*
* @author David Masshardt - initial contribution
*
*/
@ThingActionsScope(name = "onkyo")
@NonNullByDefault
public class OnkyoThingActionsService implements ThingActions, OnkyoThingActions {
private final Logger logger = LoggerFactory.getLogger(OnkyoThingActionsService.class);
private @Nullable OnkyoHandler handler;
@Override
@SuppressWarnings("null")
@RuleAction(label = "Onkyo sendRawCommand", description = "Action that sends raw command to the receiver")
public void sendRawCommand(@ActionInput(name = "command") @Nullable String command,
@ActionInput(name = "command") @Nullable String value) {
logger.debug("sendRawCommand called with raw command: {} value: {}", command, value);
if (handler == null) {
logger.warn("Onkyo Action service ThingHandler is null!");
return;
}
handler.sendRawCommand(command, value);
}
public static void sendRawCommand(@Nullable ThingActions actions, @Nullable String command,
@Nullable String value) {
invokeMethodOf(actions).sendRawCommand(command, value);
}
private static OnkyoThingActions invokeMethodOf(@Nullable ThingActions actions) {
if (actions == null) {
throw new IllegalArgumentException("actions cannot be null");
}
if (actions.getClass().getName().equals(OnkyoThingActionsService.class.getName())) {
if (actions instanceof OnkyoThingActions) {
return (OnkyoThingActions) actions;
} else {
return (OnkyoThingActions) Proxy.newProxyInstance(OnkyoThingActions.class.getClassLoader(),
new Class[] { OnkyoThingActions.class }, (Object proxy, Method method, Object[] args) -> {
Method m = actions.getClass().getDeclaredMethod(method.getName(),
method.getParameterTypes());
return m.invoke(actions, args);
});
}
}
throw new IllegalArgumentException("Actions is not an instance of OnkyoThingActionsService");
}
@Override
public void setThingHandler(@Nullable ThingHandler handler) {
if (handler instanceof OnkyoHandler) {
this.handler = (OnkyoHandler) handler;
}
}
@Override
public @Nullable ThingHandler getThingHandler() {
return this.handler;
}
}

4
bundles/org.openhab.binding.onkyo/src/main/java/org/openhab/binding/onkyo/internal/handler/OnkyoHandler.java
View File

@@ -32,7 +32,7 @@ import org.openhab.binding.onkyo.internal.OnkyoConnection;
import org.openhab.binding.onkyo.internal.OnkyoEventListener;
import org.openhab.binding.onkyo.internal.OnkyoStateDescriptionProvider;
import org.openhab.binding.onkyo.internal.ServiceType;
import org.openhab.binding.onkyo.internal.automation.modules.OnkyoThingActionsService;
import org.openhab.binding.onkyo.internal.automation.modules.OnkyoThingActions;
import org.openhab.binding.onkyo.internal.config.OnkyoDeviceConfiguration;
import org.openhab.binding.onkyo.internal.eiscp.EiscpCommand;
import org.openhab.binding.onkyo.internal.eiscp.EiscpMessage;
@@ -910,6 +910,6 @@ public class OnkyoHandler extends UpnpAudioSinkHandler implements OnkyoEventList
@Override
public Collection<Class<? extends ThingHandlerService>> getServices() {
return Collections.singletonList(OnkyoThingActionsService.class);
return Collections.singletonList(OnkyoThingActions.class);
}
}