summaryrefslogtreecommitdiff
path: root/qpid/java/broker/src/main/java/org/apache/qpid/server/configuration/plugins/SlowConsumerDetectionQueueConfiguration.java
blob: cb3bb5a77f8453ffedd9226b3326db7bb003a78c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
package org.apache.qpid.server.configuration.plugins;

import org.apache.commons.configuration.Configuration;
import org.apache.commons.configuration.ConfigurationException;

import org.apache.qpid.server.plugins.PluginManager;
import org.apache.qpid.server.registry.ApplicationRegistry;
import org.apache.qpid.slowconsumerdetection.policies.SlowConsumerPolicyPlugin;
import org.apache.qpid.slowconsumerdetection.policies.SlowConsumerPolicyPluginFactory;

import java.util.Arrays;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

public class SlowConsumerDetectionQueueConfiguration extends ConfigurationPlugin
{
    private SlowConsumerPolicyPlugin _policyPlugin;

    public static class SlowConsumerDetectionQueueConfigurationFactory implements ConfigurationPluginFactory
    {
        public ConfigurationPlugin newInstance(String path, Configuration config) throws ConfigurationException
        {
            SlowConsumerDetectionQueueConfiguration slowConsumerConfig = new SlowConsumerDetectionQueueConfiguration();
            slowConsumerConfig.setConfiguration(path, config);
            return slowConsumerConfig;
        }

        public List<String> getParentPaths()
        {
            return Arrays.asList(
                    "virtualhosts.virtualhost.queues.slow-consumer-detection",
                    "virtualhosts.virtualhost.queues.queue.slow-consumer-detection",
                    "virtualhosts.virtualhost.topics.slow-consumer-detection",
                    "virtualhosts.virtualhost.topics.topic.slow-consumer-detection");
        }
    }

    public String[] getElementsProcessed()
    {
        return new String[]{"messageAge",
                            "depth",
                            "messageCount"};
    }

    public long getMessageAge()
    {
        return getLongValue("messageAge");
    }

    public long getDepth()
    {
        return getLongValue("depth");
    }

    public long getMessageCount()
    {
        return getLongValue("messageCount");
    }

    public SlowConsumerPolicyPlugin getPolicy()
    {
        return _policyPlugin;
    }

    @Override
    public void validateConfiguration() throws ConfigurationException
    {
        PluginManager pluginManager;
        try
        {
            pluginManager = ApplicationRegistry.getInstance().getPluginManager();
        }
        catch (IllegalStateException ise)
        {
            // We see this happen during shutdown due to asynchronous reconfig performed IO threads
            // running at the same time as the shutdown handler.
            _policyPlugin = null;
            return;
        }

        if (!containsPositiveLong("messageAge") &&
            !containsPositiveLong("depth") &&
            !containsPositiveLong("messageCount"))
        {
            throw new ConfigurationException("At least one configuration property" +
                                             "('messageAge','depth' or 'messageCount') must be specified.");
        }

        SlowConsumerDetectionPolicyConfiguration policyConfig = getConfiguration(SlowConsumerDetectionPolicyConfiguration.class.getName());
        Map<String, SlowConsumerPolicyPluginFactory> factories = pluginManager.getSlowConsumerPlugins();

        if (policyConfig == null)
        {
            throw new ConfigurationException("No Slow Consumer Policy specified. Known Policies:" + factories.keySet());
        }

        if (_logger.isDebugEnabled())
        {
            Iterator<?> keys = policyConfig.getConfig().getKeys();

            while (keys.hasNext())
            {
                String key = (String) keys.next();

                _logger.debug("Policy Keys:" + key);
            }

        }

        SlowConsumerPolicyPluginFactory<SlowConsumerPolicyPlugin> pluginFactory = factories.get(policyConfig.getPolicyName().toLowerCase());

        if (pluginFactory == null)
        {
            throw new ConfigurationException("Unknown Slow Consumer Policy specified:" + policyConfig.getPolicyName() + " Known Policies:" + factories.keySet());
        }

        _policyPlugin = pluginFactory.newInstance(policyConfig);

        // Debug the creation of this Config
        _logger.debug(this);
    }

    public String formatToString()
    {
        StringBuilder sb = new StringBuilder();
        if (getMessageAge() > 0)
        {
            sb.append("Age:").append(getMessageAge()).append(":");
        }
        if (getDepth() > 0)
        {
            sb.append("Depth:").append(getDepth()).append(":");
        }
        if (getMessageCount() > 0)
        {
            sb.append("Count:").append(getMessageCount()).append(":");
        }

        sb.append("Policy[").append(getPolicy()).append("]");
        return sb.toString();
    }
}