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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
|
/*
*
* 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.management.common.mbeans;
import java.io.IOException;
import java.util.Date;
import java.security.Principal;
import javax.management.JMException;
import javax.management.MBeanOperationInfo;
import javax.management.openmbean.TabularData;
import org.apache.qpid.management.common.mbeans.annotations.MBeanAttribute;
import org.apache.qpid.management.common.mbeans.annotations.MBeanOperation;
import org.apache.qpid.management.common.mbeans.annotations.MBeanOperationParameter;
/**
* The management interface exposed to allow management of Connections.
*
* @since Qpid JMX API 1.9
*/
public interface ManagedConnection
{
static final String TYPE = "Connection";
//TabularType and contained CompositeType key/description information
//For compatibility reasons, DONT MODIFY the existing key values if expanding the set.
//"Flow Blocked" added in Qpid JMX API 1.5
String[] COMPOSITE_ITEM_NAMES = {"Channel Id", "Transactional", "Default Queue", "Unacknowledged Message Count", "Flow Blocked"};
String[] COMPOSITE_ITEM_DESCRIPTIONS = {"Channel Id", "Transactional", "Default Queue", "Unacknowledged Message Count", "Flow Blocked"};
String[] TABULAR_UNIQUE_INDEX = {COMPOSITE_ITEM_NAMES[0]};
@MBeanAttribute(name = "ClientId", description = "Client Id")
String getClientId();
@MBeanAttribute(name = "AuthorizedId", description = "User Name")
String getAuthorizedId();
@MBeanAttribute(name = "Version", description = "Client Version")
String getVersion();
/**
* Tells the remote address of this connection.
* @return remote address
*/
@MBeanAttribute(name="RemoteAddress", description=TYPE + " Address")
String getRemoteAddress();
/**
* Tells the last time, the IO operation was done.
* @return last IO time.
*/
@MBeanAttribute(name="LastIOTime", description="The last time, the IO operation was done")
Date getLastIoTime();
/**
* Tells the total number of bytes written till now.
* @return number of bytes written.
*
@MBeanAttribute(name="WrittenBytes", description="The total number of bytes written till now")
Long getWrittenBytes();
*/
/**
* Tells the total number of bytes read till now.
* @return number of bytes read.
*
@MBeanAttribute(name="ReadBytes", description="The total number of bytes read till now")
Long getReadBytes();
*/
/**
* Threshold high value for no of channels. This is useful in setting notifications or
* taking required action is there are more channels being created.
* @return threshold limit for no of channels
*/
Long getMaximumNumberOfChannels();
/**
* Sets the threshold high value for number of channels for a connection
* @param value
*/
@MBeanAttribute(name="MaximumNumberOfChannels", description="The threshold high value for number of channels for this connection")
void setMaximumNumberOfChannels(Long value);
//********** Operations *****************//
/**
* channel details of all the channels opened for this connection.
* @return general channel details
* @throws IOException
* @throws JMException
*/
@MBeanOperation(name="channels", description="Channel details for this connection")
TabularData channels() throws IOException, JMException;
/**
* Commits the transactions if the channel is transactional.
* @param channelId
* @throws JMException
*/
@MBeanOperation(name="commitTransaction",
description="Commits the transactions for given channel Id, if the channel is transactional",
impact= MBeanOperationInfo.ACTION)
void commitTransactions(@MBeanOperationParameter(name="channel Id", description="channel Id")int channelId) throws JMException;
/**
* Rollsback the transactions if the channel is transactional.
* @param channelId
* @throws JMException
*/
@MBeanOperation(name="rollbackTransactions",
description="Rollsback the transactions for given channel Id, if the channel is transactional",
impact= MBeanOperationInfo.ACTION)
void rollbackTransactions(@MBeanOperationParameter(name="channel Id", description="channel Id")int channelId) throws JMException;
/**
* Closes all the related channels and unregisters this connection from managed objects.
*/
@MBeanOperation(name="closeConnection",
description="Closes this connection and all related channels",
impact= MBeanOperationInfo.ACTION)
void closeConnection() throws Exception;
/**
* Resets message and data statistics for this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanOperation(name="resetStatistics",
description="Resets message and data statistics for this connection",
impact= MBeanOperationInfo.ACTION)
void resetStatistics() throws Exception;
/**
* Peak rate of messages per second on this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="peakMessageRate", description=TYPE + " Peak Message Rate")
double getPeakMessageRate();
/**
* Peak rate of bytes per second on this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="peakDataRate", description=TYPE + " Peak Data Rate")
double getPeakDataRate();
/**
* Rate of messages per second on this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="messageRate", description=TYPE + " Message Rate")
double getMessageRate();
/**
* Rate of bytes per second on this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="dataRate", description=TYPE + " Data Rate")
double getDataRate();
/**
* Total count of messages on this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="totalMessages", description=TYPE + " Total Message Count")
long getTotalMessages();
/**
* Total count of bytes on this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="totalData", description=TYPE + " Total Bytes")
long getTotalData();
/**
* Is statistics collection enabled for this connection.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="statisticsEnabled", description=TYPE + " Statistics Enabled")
boolean isStatisticsEnabled();
void setStatisticsEnabled(boolean enabled);
}
|
