Skip to content

GH-4002: Deprecate ConsumerStopAction in MQTT #4006

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

Merged
merged 1 commit into from
Feb 6, 2023
Merged

GH-4002: Deprecate ConsumerStopAction in MQTT #4006

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
9 changes: 7 additions & 2 deletions ...tion-mqtt/src/main/java/org/springframework/integration/mqtt/core/ConsumerStopAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2015-2019 the original author or authors.
* Copyright 2015-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -17,12 +17,17 @@
package org.springframework.integration.mqtt.core;

/**
* Action to take regarding subscrptions when consumer stops.
* Action to take regarding subscriptions when consumer stops.
*
* @author Gary Russell
*
* @since 4.2.3
*
* @deprecated since 5.5.17
* in favor of standard {@link org.eclipse.paho.client.mqttv3.MqttConnectOptions#setCleanSession(boolean)}.
* Will be removed in 6.1.0.
*/
@Deprecated
public enum ConsumerStopAction {

/**
Expand Down
9 changes: 8 additions & 1 deletion ...src/main/java/org/springframework/integration/mqtt/core/DefaultMqttPahoClientFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -41,6 +41,7 @@ public class DefaultMqttPahoClientFactory implements MqttPahoClientFactory {

private MqttClientPersistence persistence;

@SuppressWarnings("deprecation")
private ConsumerStopAction consumerStopAction = ConsumerStopAction.UNSUBSCRIBE_CLEAN;

/**
Expand All @@ -55,7 +56,10 @@ public void setPersistence(MqttClientPersistence persistence) {
* Get the consumer stop action.
* @return the consumer stop action.
* @since 4.2.3
* @deprecated since 5.5.17 in favor of standard {@link MqttConnectOptions#setCleanSession(boolean)}.
* Will be removed in 6.1.0.
*/
@Deprecated
@Override
public ConsumerStopAction getConsumerStopAction() {
return this.consumerStopAction;
Expand All @@ -66,7 +70,10 @@ public ConsumerStopAction getConsumerStopAction() {
* Default: {@link ConsumerStopAction#UNSUBSCRIBE_CLEAN}.
* @param consumerStopAction the consumer stop action.
* @since 4.2.3.
* @deprecated since 5.5.17 in favor of standard {@link MqttConnectOptions#setCleanSession(boolean)}.
* Will be removed in 6.1.0.
*/
@Deprecated
public void setConsumerStopAction(ConsumerStopAction consumerStopAction) {
this.consumerStopAction = consumerStopAction;
}
Expand Down
5 changes: 4 additions & 1 deletion ...n-mqtt/src/main/java/org/springframework/integration/mqtt/core/MqttPahoClientFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -60,7 +60,10 @@ public interface MqttPahoClientFactory {
* Get the consumer stop action.
* @return the consumer stop action.
* @since 4.3
* @deprecated since 5.5.17 in favor of standard {@link MqttConnectOptions#setCleanSession(boolean)}.
* Will be removed in 6.1.0.
*/
@Deprecated
ConsumerStopAction getConsumerStopAction();

}
16 changes: 10 additions & 6 deletions ...ava/org/springframework/integration/mqtt/inbound/MqttPahoMessageDrivenChannelAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -32,7 +32,6 @@
import org.springframework.integration.IntegrationMessageHeaderAccessor;
import org.springframework.integration.acks.SimpleAcknowledgment;
import org.springframework.integration.mqtt.core.ClientManager;
import org.springframework.integration.mqtt.core.ConsumerStopAction;
import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory;
import org.springframework.integration.mqtt.core.MqttPahoClientFactory;
import org.springframework.integration.mqtt.core.MqttPahoComponent;
Expand Down Expand Up @@ -78,7 +77,8 @@ public class MqttPahoMessageDrivenChannelAdapter

private volatile boolean cleanSession;

private volatile ConsumerStopAction consumerStopAction;
@SuppressWarnings("deprecation")
private volatile org.springframework.integration.mqtt.core.ConsumerStopAction consumerStopAction;

/**
* Use this constructor when you don't need additional {@link MqttConnectOptions}.
Expand Down Expand Up @@ -195,11 +195,14 @@ protected void doStart() {
}
}

@SuppressWarnings("deprecation")
@Override
protected synchronized void doStop() {
try {
if (this.consumerStopAction.equals(ConsumerStopAction.UNSUBSCRIBE_ALWAYS)
|| (this.consumerStopAction.equals(ConsumerStopAction.UNSUBSCRIBE_CLEAN)
if (this.consumerStopAction
.equals(org.springframework.integration.mqtt.core.ConsumerStopAction.UNSUBSCRIBE_ALWAYS)
|| (this.consumerStopAction
.equals(org.springframework.integration.mqtt.core.ConsumerStopAction.UNSUBSCRIBE_CLEAN)
&& this.cleanSession)) {

this.client.unsubscribe(getTopic());
Expand Down Expand Up @@ -270,12 +273,13 @@ public void removeTopic(String... topic) {
}
}

@SuppressWarnings("deprecation")
private synchronized void connect() throws MqttException { // NOSONAR
MqttConnectOptions connectionOptions = this.clientFactory.getConnectionOptions();
this.cleanSession = connectionOptions.isCleanSession();
this.consumerStopAction = this.clientFactory.getConsumerStopAction();
if (this.consumerStopAction == null) {
this.consumerStopAction = ConsumerStopAction.UNSUBSCRIBE_CLEAN;
this.consumerStopAction = org.springframework.integration.mqtt.core.ConsumerStopAction.UNSUBSCRIBE_CLEAN;
}

var clientManager = getClientManager();
Expand Down
37 changes: 5 additions & 32 deletions ...integration-mqtt/src/test/java/org/springframework/integration/mqtt/MqttAdapterTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2002-2022 the original author or authors.
* Copyright 2002-2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -53,7 +53,6 @@
import org.springframework.integration.channel.NullChannel;
import org.springframework.integration.channel.QueueChannel;
import org.springframework.integration.handler.MessageProcessor;
import org.springframework.integration.mqtt.core.ConsumerStopAction;
import org.springframework.integration.mqtt.core.DefaultMqttPahoClientFactory;
import org.springframework.integration.mqtt.core.Mqttv3ClientManager;
import org.springframework.integration.mqtt.event.MqttConnectionFailedEvent;
Expand Down Expand Up @@ -373,7 +372,7 @@ public Message<?> toMessage(Object payload, MessageHeaders headers) {
@Test
public void testStopActionDefault() throws Exception {
final IMqttAsyncClient client = mock(IMqttAsyncClient.class);
MqttPahoMessageDrivenChannelAdapter adapter = buildAdapterIn(client, null, null);
MqttPahoMessageDrivenChannelAdapter adapter = buildAdapterIn(client, null);

adapter.start();
adapter.connectComplete(false, null);
Expand All @@ -384,30 +383,7 @@ public void testStopActionDefault() throws Exception {
@Test
public void testStopActionDefaultNotClean() throws Exception {
final IMqttAsyncClient client = mock(IMqttAsyncClient.class);
MqttPahoMessageDrivenChannelAdapter adapter = buildAdapterIn(client, false, null);

adapter.start();
adapter.connectComplete(false, null);
adapter.stop();
verifyNotUnsubscribe(client);
}

@Test
public void testStopActionAlways() throws Exception {
final IMqttAsyncClient client = mock(IMqttAsyncClient.class);
MqttPahoMessageDrivenChannelAdapter adapter = buildAdapterIn(client, false,
ConsumerStopAction.UNSUBSCRIBE_ALWAYS);

adapter.start();
adapter.connectComplete(false, null);
adapter.stop();
verifyUnsubscribe(client);
}

@Test
public void testStopActionNever() throws Exception {
final IMqttAsyncClient client = mock(IMqttAsyncClient.class);
MqttPahoMessageDrivenChannelAdapter adapter = buildAdapterIn(client, null, ConsumerStopAction.UNSUBSCRIBE_NEVER);
MqttPahoMessageDrivenChannelAdapter adapter = buildAdapterIn(client, false);

adapter.start();
adapter.connectComplete(false, null);
Expand Down Expand Up @@ -539,8 +515,8 @@ public void testDifferentQos() throws Exception {
verify(client).disconnectForcibly(5_000L);
}

private MqttPahoMessageDrivenChannelAdapter buildAdapterIn(final IMqttAsyncClient client, Boolean cleanSession,
ConsumerStopAction action) throws MqttException {
private MqttPahoMessageDrivenChannelAdapter buildAdapterIn(final IMqttAsyncClient client, Boolean cleanSession)
throws MqttException {

DefaultMqttPahoClientFactory factory = new DefaultMqttPahoClientFactory() {

Expand All @@ -555,9 +531,6 @@ public IMqttAsyncClient getAsyncClientInstance(String uri, String clientId) {
if (cleanSession != null) {
connectOptions.setCleanSession(cleanSession);
}
if (action != null) {
factory.setConsumerStopAction(action);
}
factory.setConnectionOptions(connectOptions);
given(client.isConnected()).willReturn(true);
IMqttToken token = mock(IMqttToken.class);
Expand Down