1 /*
2 * Copyright 2014 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16
17 package io.netty.handler.codec.mqtt;
18
19 import io.netty.util.internal.StringUtil;
20
21 /**
22 * Contains a topic name and Qos Level.
23 * This is part of the {@link MqttSubscribePayload}
24 */
25 public final class MqttTopicSubscription {
26
27 private String topicFilter;
28 private final MqttSubscriptionOption option;
29
30 public MqttTopicSubscription(String topicFilter, MqttQoS qualityOfService) {
31 this.topicFilter = topicFilter;
32 this.option = MqttSubscriptionOption.onlyFromQos(qualityOfService);
33 }
34
35 public MqttTopicSubscription(String topicFilter, MqttSubscriptionOption option) {
36 this.topicFilter = topicFilter;
37 this.option = option;
38 }
39
40 /**
41 * @deprecated use topicFilter
42 */
43 @Deprecated
44 public String topicName() {
45 return topicFilter;
46 }
47
48 public String topicFilter() {
49 return topicFilter;
50 }
51
52 /**
53 * Rewrite topic filter.
54 * <p>
55 *
56 * Many IoT devices do not support reconfiguration or upgrade, so it is hard to
57 * change their subscribed topics. To resolve this issue, MQTT server may offer
58 * topic rewrite capability.
59 *
60 * @param topicFilter Topic to rewrite to
61 */
62 public void setTopicFilter(String topicFilter) {
63 this.topicFilter = topicFilter;
64 }
65
66 public MqttQoS qualityOfService() {
67 return option.qos();
68 }
69
70 public MqttSubscriptionOption option() {
71 return option;
72 }
73
74 @Override
75 public String toString() {
76 return new StringBuilder(StringUtil.simpleClassName(this))
77 .append('[')
78 .append("topicFilter=").append(topicFilter)
79 .append(", option=").append(this.option)
80 .append(']')
81 .toString();
82 }
83 }