summaryrefslogtreecommitdiff
path: root/qpid/java/broker/src/main/java/org/apache/qpid/server/model/Queue.java
blob: ae2031bd71966ed5751e28243868289f76114955 (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
/*
 *
 * 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.model;

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import org.apache.qpid.server.queue.QueueEntryVisitor;

public interface Queue extends ConfiguredObject
{
    public static final String BINDING_COUNT = "bindingCount";
    public static final String CONSUMER_COUNT = "consumerCount";
    public static final String CONSUMER_COUNT_WITH_CREDIT = "consumerCountWithCredit";
    public static final String DISCARDS_TTL_BYTES = "discardsTtlBytes";
    public static final String DISCARDS_TTL_MESSAGES = "discardsTtlMessages";
    public static final String PERSISTENT_DEQUEUED_BYTES = "persistentDequeuedBytes";
    public static final String PERSISTENT_DEQUEUED_MESSAGES = "persistentDequeuedMessages";
    public static final String PERSISTENT_ENQUEUED_BYTES = "persistentEnqueuedBytes";
    public static final String PERSISTENT_ENQUEUED_MESSAGES = "persistentEnqueuedMessages";
    public static final String QUEUE_DEPTH_BYTES = "queueDepthBytes";
    public static final String QUEUE_DEPTH_MESSAGES = "queueDepthMessages";
    public static final String STATE_CHANGED = "stateChanged";
    public static final String TOTAL_DEQUEUED_BYTES = "totalDequeuedBytes";
    public static final String TOTAL_DEQUEUED_MESSAGES = "totalDequeuedMessages";
    public static final String TOTAL_ENQUEUED_BYTES = "totalEnqueuedBytes";
    public static final String TOTAL_ENQUEUED_MESSAGES = "totalEnqueuedMessages";
    public static final String UNACKNOWLEDGED_BYTES = "unacknowledgedBytes";
    public static final String UNACKNOWLEDGED_MESSAGES = "unacknowledgedMessages";

    public static final Collection<String> AVAILABLE_STATISTICS =
            Collections.unmodifiableList(
                    Arrays.asList(BINDING_COUNT,
                                  CONSUMER_COUNT,
                                  CONSUMER_COUNT_WITH_CREDIT,
                                  DISCARDS_TTL_BYTES,
                                  DISCARDS_TTL_MESSAGES,
                                  PERSISTENT_DEQUEUED_BYTES,
                                  PERSISTENT_DEQUEUED_MESSAGES,
                                  PERSISTENT_ENQUEUED_BYTES,
                                  PERSISTENT_ENQUEUED_MESSAGES,
                                  QUEUE_DEPTH_BYTES,
                                  QUEUE_DEPTH_MESSAGES,
                                  STATE_CHANGED,
                                  TOTAL_DEQUEUED_BYTES,
                                  TOTAL_DEQUEUED_MESSAGES,
                                  TOTAL_ENQUEUED_BYTES,
                                  TOTAL_ENQUEUED_MESSAGES,
                                  UNACKNOWLEDGED_BYTES,
                                  UNACKNOWLEDGED_MESSAGES));



    public static final String ID = "id";
    public static final String DESCRIPTION = "description";
    public static final String NAME = "name";
    public static final String STATE = "state";
    public static final String DURABLE = "durable";
    public static final String LIFETIME_POLICY = "lifetimePolicy";
    public static final String TIME_TO_LIVE = "timeToLive";
    public static final String CREATED = "created";
    public static final String UPDATED = "updated";
    public static final String ARGUMENTS = "arguments";

    public static final String ALERT_REPEAT_GAP = "alertRepeatGap";
    public static final String ALERT_THRESHOLD_MESSAGE_AGE = "alertThresholdMessageAge";
    public static final String ALERT_THRESHOLD_MESSAGE_SIZE = "alertThresholdMessageSize";
    public static final String ALERT_THRESHOLD_QUEUE_DEPTH_BYTES = "alertThresholdQueueDepthBytes";
    public static final String ALERT_THRESHOLD_QUEUE_DEPTH_MESSAGES = "alertThresholdQueueDepthMessages";
    public static final String ALTERNATE_EXCHANGE = "alternateExchange";
    public static final String EXCLUSIVE = "exclusive";
    public static final String MESSAGE_GROUP_KEY = "messageGroupKey";
    public static final String MESSAGE_GROUP_SHARED_GROUPS = "messageGroupSharedGroups";
    public static final String MESSAGE_GROUP_DEFAULT_GROUP = "messageGroupDefaultGroup";
    public static final String LVQ_KEY = "lvqKey";
    public static final String MAXIMUM_DELIVERY_ATTEMPTS = "maximumDeliveryAttempts";
    public static final String NO_LOCAL = "noLocal";
    public static final String OWNER = "owner";
    public static final String QUEUE_FLOW_CONTROL_SIZE_BYTES = "queueFlowControlSizeBytes";
    public static final String QUEUE_FLOW_RESUME_SIZE_BYTES = "queueFlowResumeSizeBytes";
    public static final String QUEUE_FLOW_STOPPED = "queueFlowStopped";
    public static final String SORT_KEY = "sortKey";
    public static final String TYPE = "type";
    public static final String PRIORITIES = "priorities";

    public static final String CREATE_DLQ_ON_CREATION = "x-qpid-dlq-enabled"; // TODO - this value should change

    public static final String FEDERATION_EXCLUDES = "federationExcludes";
    public static final String FEDERATION_ID = "federationId";


    public static final Collection<String> AVAILABLE_ATTRIBUTES =
            Collections.unmodifiableList(
                    Arrays.asList(ID,
                                  NAME,
                                  DESCRIPTION,
                                  STATE,
                                  DURABLE,
                                  LIFETIME_POLICY,
                                  TIME_TO_LIVE,
                                  CREATED,
                                  UPDATED,
                                  TYPE,
                                  ALTERNATE_EXCHANGE,
                                  EXCLUSIVE,
                                  OWNER,
                                  NO_LOCAL,
                                  LVQ_KEY,
                                  SORT_KEY,
                                  MESSAGE_GROUP_KEY,
                                  MESSAGE_GROUP_SHARED_GROUPS,
                                  MAXIMUM_DELIVERY_ATTEMPTS,
                                  QUEUE_FLOW_CONTROL_SIZE_BYTES,
                                  QUEUE_FLOW_RESUME_SIZE_BYTES,
                                  QUEUE_FLOW_STOPPED,
                                  ALERT_THRESHOLD_MESSAGE_AGE,
                                  ALERT_THRESHOLD_MESSAGE_SIZE,
                                  ALERT_THRESHOLD_QUEUE_DEPTH_BYTES,
                                  ALERT_THRESHOLD_QUEUE_DEPTH_MESSAGES,
                                  ALERT_REPEAT_GAP,
                                  PRIORITIES
                    ));


    //children
    Collection<Binding> getBindings();
    Collection<Consumer> getConsumers();


    //operations

    void visit(QueueEntryVisitor visitor);

    void delete();

    void setNotificationListener(QueueNotificationListener listener);
}