activemq-cpp-3.6.0
AdvisorySupport.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 #ifndef _ACTIVEMQ_UTIL_ADVISORYSUPPORT_H_
19 #define _ACTIVEMQ_UTIL_ADVISORYSUPPORT_H_
20 
21 #include <activemq/util/Config.h>
22 
23 #include <string>
24 #include <vector>
25 
26 namespace cms {
27  class Destination;
28 }
29 namespace activemq {
30 namespace commands {
31  class ActiveMQDestination;
32 }
33 namespace util {
34 
41  class AMQCPP_API AdvisorySupport {
42  private:
43 
44  AdvisorySupport();
45 
46  public:
47 
48  static const std::string ADVISORY_TOPIC_PREFIX;
49  static const std::string PRODUCER_ADVISORY_TOPIC_PREFIX;
50  static const std::string QUEUE_PRODUCER_ADVISORY_TOPIC_PREFIX;
51  static const std::string TOPIC_PRODUCER_ADVISORY_TOPIC_PREFIX;
52  static const std::string CONSUMER_ADVISORY_TOPIC_PREFIX;
53  static const std::string QUEUE_CONSUMER_ADVISORY_TOPIC_PREFIX;
54  static const std::string TOPIC_CONSUMER_ADVISORY_TOPIC_PREFIX;
55  static const std::string EXPIRED_TOPIC_MESSAGES_TOPIC_PREFIX;
56  static const std::string EXPIRED_QUEUE_MESSAGES_TOPIC_PREFIX;
57  static const std::string NO_TOPIC_CONSUMERS_TOPIC_PREFIX;
58  static const std::string NO_QUEUE_CONSUMERS_TOPIC_PREFIX;
59  static const std::string SLOW_CONSUMER_TOPIC_PREFIX;
60  static const std::string FAST_PRODUCER_TOPIC_PREFIX;
61  static const std::string MESSAGE_DISCAREDED_TOPIC_PREFIX;
62  static const std::string FULL_TOPIC_PREFIX;
63  static const std::string MESSAGE_DELIVERED_TOPIC_PREFIX;
64  static const std::string MESSAGE_CONSUMED_TOPIC_PREFIX;
65  static const std::string MESSAGE_DLQ_TOPIC_PREFIX;
66  static const std::string MASTER_BROKER_TOPIC_PREFIX;
67  static const std::string NETWORK_BRIDGE_TOPIC_PREFIX;
68  static const std::string AGENT_TOPIC;
69  static const std::string ADIVSORY_MESSAGE_TYPE;
70  static const std::string MSG_PROPERTY_ORIGIN_BROKER_ID;
71  static const std::string MSG_PROPERTY_ORIGIN_BROKER_NAME;
72  static const std::string MSG_PROPERTY_ORIGIN_BROKER_URL;
73  static const std::string MSG_PROPERTY_USAGE_NAME;
74  static const std::string MSG_PROPERTY_CONSUMER_ID;
75  static const std::string MSG_PROPERTY_PRODUCER_ID;
76  static const std::string MSG_PROPERTY_MESSAGE_ID;
77  static const std::string MSG_PROPERTY_CONSUMER_COUNT;
78  static const std::string MSG_PROPERTY_DISCARDED_COUNT;
79 
80  public:
81 
82  ~AdvisorySupport();
83 
84  public:
85 
92  static commands::ActiveMQDestination* getTempDestinationCompositeAdvisoryTopic();
93 
100  static commands::ActiveMQDestination* getAllDestinationsCompositeAdvisoryTopic();
101 
108  static std::vector<commands::ActiveMQDestination*> getAllDestinationAdvisoryTopics(const cms::Destination* destination);
109 
116  static std::vector<commands::ActiveMQDestination*> getAllDestinationAdvisoryTopics(const commands::ActiveMQDestination* destination);
117 
123  static commands::ActiveMQDestination* getConnectionAdvisoryTopic();
124 
130  static commands::ActiveMQDestination* getQueueAdvisoryTopic();
131 
137  static commands::ActiveMQDestination* getTopicAdvisoryTopic();
138 
144  static commands::ActiveMQDestination* getTempQueueAdvisoryTopic();
145 
151  static commands::ActiveMQDestination* getTempTopicAdvisoryTopic();
152 
158  static commands::ActiveMQDestination* getConsumerAdvisoryTopic(const cms::Destination* destination);
159 
165  static commands::ActiveMQDestination* getConsumerAdvisoryTopic(const commands::ActiveMQDestination* destination);
166 
172  static commands::ActiveMQDestination* getProducerAdvisoryTopic(const cms::Destination* destination);
173 
179  static commands::ActiveMQDestination* getProducerAdvisoryTopic(const commands::ActiveMQDestination* destination);
180 
187  static commands::ActiveMQDestination* getExpiredMessageTopic(const cms::Destination* destination);
188 
195  static commands::ActiveMQDestination* getExpiredMessageTopic(const commands::ActiveMQDestination* destination);
196 
203  static commands::ActiveMQDestination* getExpiredTopicMessageAdvisoryTopic(const cms::Destination* destination);
204 
211  static commands::ActiveMQDestination* getExpiredTopicMessageAdvisoryTopic(const commands::ActiveMQDestination* destination);
212 
219  static commands::ActiveMQDestination* getExpiredQueueMessageAdvisoryTopic(const cms::Destination* destination);
220 
227  static commands::ActiveMQDestination* getExpiredQueueMessageAdvisoryTopic(const commands::ActiveMQDestination* destination);
228 
235  static commands::ActiveMQDestination* getNoConsumersAdvisoryTopic(const cms::Destination* destination);
236 
243  static commands::ActiveMQDestination* getNoConsumersAdvisoryTopic(const commands::ActiveMQDestination* destination);
244 
251  static commands::ActiveMQDestination* getNoTopicConsumersAdvisoryTopic(const cms::Destination* destination);
252 
259  static commands::ActiveMQDestination* getNoTopicConsumersAdvisoryTopic(const commands::ActiveMQDestination* destination);
260 
267  static commands::ActiveMQDestination* getNoQueueConsumersAdvisoryTopic(const cms::Destination* destination);
268 
275  static commands::ActiveMQDestination* getNoQueueConsumersAdvisoryTopic(const commands::ActiveMQDestination* destination);
276 
283  static commands::ActiveMQDestination* getSlowConsumerAdvisoryTopic(const cms::Destination* destination);
284 
291  static commands::ActiveMQDestination* getSlowConsumerAdvisoryTopic(const commands::ActiveMQDestination* destination);
292 
299  static commands::ActiveMQDestination* getFastProducerAdvisoryTopic(const cms::Destination* destination);
300 
307  static commands::ActiveMQDestination* getFastProducerAdvisoryTopic(const commands::ActiveMQDestination* destination);
308 
315  static commands::ActiveMQDestination* getMessageDiscardedAdvisoryTopic(const cms::Destination* destination);
316 
323  static commands::ActiveMQDestination* getMessageDiscardedAdvisoryTopic(const commands::ActiveMQDestination* destination);
324 
331  static commands::ActiveMQDestination* getMessageDeliveredAdvisoryTopic(const cms::Destination* destination);
332 
339  static commands::ActiveMQDestination* getMessageDeliveredAdvisoryTopic(const commands::ActiveMQDestination* destination);
340 
347  static commands::ActiveMQDestination* getMessageConsumedAdvisoryTopic(const cms::Destination* destination);
348 
355  static commands::ActiveMQDestination* getMessageConsumedAdvisoryTopic(const commands::ActiveMQDestination* destination);
356 
363  static commands::ActiveMQDestination* getMessageDLQdAdvisoryTopic(const cms::Destination* destination);
364 
371  static commands::ActiveMQDestination* getMessageDLQdAdvisoryTopic(const commands::ActiveMQDestination* destination);
372 
378  static commands::ActiveMQDestination* getMasterBrokerAdvisoryTopic();
379 
385  static commands::ActiveMQDestination* getNetworkBridgeAdvisoryTopic();
386 
393  static commands::ActiveMQDestination* getFullAdvisoryTopic(const cms::Destination* destination);
394 
401  static commands::ActiveMQDestination* getFullAdvisoryTopic(const commands::ActiveMQDestination* destination);
402 
409  static commands::ActiveMQDestination* getDestinationAdvisoryTopic(const cms::Destination* destination);
410 
417  static commands::ActiveMQDestination* getDestinationAdvisoryTopic(const commands::ActiveMQDestination* destination);
418 
419  public:
420 
424  static bool isDestinationAdvisoryTopic(const cms::Destination* destination);
425 
429  static bool isDestinationAdvisoryTopic(const commands::ActiveMQDestination* destination);
430 
434  static bool isTempDestinationAdvisoryTopic(const cms::Destination* destination);
435 
439  static bool isTempDestinationAdvisoryTopic(const commands::ActiveMQDestination* destination);
440 
444  static bool isAdvisoryTopic(const cms::Destination* destination);
445 
449  static bool isAdvisoryTopic(const commands::ActiveMQDestination* destination);
450 
454  static bool isConnectionAdvisoryTopic(const cms::Destination* destination);
455 
459  static bool isConnectionAdvisoryTopic(const commands::ActiveMQDestination* destination);
460 
464  static bool isProducerAdvisoryTopic(const cms::Destination* destination);
465 
469  static bool isProducerAdvisoryTopic(const commands::ActiveMQDestination* destination);
470 
474  static bool isConsumerAdvisoryTopic(const cms::Destination* destination);
475 
479  static bool isConsumerAdvisoryTopic(const commands::ActiveMQDestination* destination);
480 
484  static bool isSlowConsumerAdvisoryTopic(const cms::Destination* destination);
485 
489  static bool isSlowConsumerAdvisoryTopic(const commands::ActiveMQDestination* destination);
490 
494  static bool isFastProducerAdvisoryTopic(const cms::Destination* destination);
495 
499  static bool isFastProducerAdvisoryTopic(const commands::ActiveMQDestination* destination);
500 
504  static bool isMessageConsumedAdvisoryTopic(const cms::Destination* destination);
505 
509  static bool isMessageConsumedAdvisoryTopic(const commands::ActiveMQDestination* destination);
510 
514  static bool isMasterBrokerAdvisoryTopic(const cms::Destination* destination);
515 
519  static bool isMasterBrokerAdvisoryTopic(const commands::ActiveMQDestination* destination);
520 
524  static bool isMessageDeliveredAdvisoryTopic(const cms::Destination* destination);
525 
529  static bool isMessageDeliveredAdvisoryTopic(const commands::ActiveMQDestination* destination);
530 
534  static bool isMessageDiscardedAdvisoryTopic(const cms::Destination* destination);
535 
539  static bool isMessageDiscardedAdvisoryTopic(const commands::ActiveMQDestination* destination);
540 
544  static bool isMessageDLQdAdvisoryTopic(const cms::Destination* destination);
545 
549  static bool isMessageDLQdAdvisoryTopic(const commands::ActiveMQDestination* destination);
550 
554  static bool isFullAdvisoryTopic(const cms::Destination* destination);
555 
559  static bool isFullAdvisoryTopic(const commands::ActiveMQDestination* destination);
560 
564  static bool isNetworkBridgeAdvisoryTopic(const cms::Destination* destination);
565 
569  static bool isNetworkBridgeAdvisoryTopic(const commands::ActiveMQDestination* destination);
570 
571  };
572 
573 }}
574 
575 #endif /* _ACTIVEMQ_UTIL_ADVISORYSUPPORT_H_ */