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.

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

[MQTT] Workaround for thing actions bug #8140

Merged
merged 2 commits into from
Jul 16, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
/**
* 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.mqtt.action;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;

/**
* The {@link IMQTTActions} defines the interface for all thing actions supported by the binding.
*
* @author Laurent Garnier - Initial contribution
*/
@NonNullByDefault
public interface IMQTTActions {

public void publishMQTT(@Nullable String topic, @Nullable String value, @Nullable Boolean retain);
}
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
*/
package org.openhab.binding.mqtt.action;

import java.lang.reflect.Method;
import java.lang.reflect.Proxy;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.smarthome.core.thing.binding.ThingActions;
Expand All @@ -25,14 +28,18 @@
import org.slf4j.LoggerFactory;

/**
* This is the automation engine action handler service for the
* publishMQTT action.
* This is the automation engine action handler service for the publishMQTT action.
* <p>
* <b>Note:</b>The static method <b>invokeMethodOf</b> handles the case where
* the test <i>actions instanceof MQTTActions</i> fails. This test can fail
* due to an issue in openHAB core v2.5.0 where the {@link MQTTActions} class
* can be loaded by a different classloader than the <i>actions</i> instance.
*
* @author David Graeff - Initial contribution
*/
@ThingActionsScope(name = "mqtt")
@NonNullByDefault
public class MQTTActions implements ThingActions {
public class MQTTActions implements ThingActions, IMQTTActions {
private final Logger logger = LoggerFactory.getLogger(MQTTActions.class);
private @Nullable AbstractBrokerHandler handler;

Expand All @@ -53,6 +60,7 @@ public void publishMQTT(
publishMQTT(topic, value, null);
}

@Override
@RuleAction(label = "@text/actionLabel", description = "@text/actionDesc")
public void publishMQTT(
@ActionInput(name = "topic", label = "@text/actionInputTopicLabel", description = "@text/actionInputTopicDesc") @Nullable String topic,
Expand Down Expand Up @@ -93,10 +101,25 @@ public static void publishMQTT(@Nullable ThingActions actions, @Nullable String

public static void publishMQTT(@Nullable ThingActions actions, @Nullable String topic, @Nullable String value,
@Nullable Boolean retain) {
if (actions instanceof MQTTActions) {
((MQTTActions) actions).publishMQTT(topic, value, retain);
} else {
throw new IllegalArgumentException("Instance is not an MQTTActions class.");
invokeMethodOf(actions).publishMQTT(topic, value, retain);
}

private static IMQTTActions invokeMethodOf(@Nullable ThingActions actions) {
if (actions == null) {
throw new IllegalArgumentException("actions cannot be null");
}
if (actions.getClass().getName().equals(MQTTActions.class.getName())) {
if (actions instanceof IMQTTActions) {
return (IMQTTActions) actions;
} else {
return (IMQTTActions) Proxy.newProxyInstance(IMQTTActions.class.getClassLoader(),
new Class[] { IMQTTActions.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 MQTTActions");
}
}