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
|
/*
* 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 javax.management.MBeanOperationInfo;
import org.apache.qpid.management.common.mbeans.annotations.MBeanAttribute;
import org.apache.qpid.management.common.mbeans.annotations.MBeanOperation;
/**
* Interface for the ServerInformation MBean
*
* @since Qpid JMX API 1.9
*/
public interface ServerInformation
{
String TYPE = "ServerInformation";
/* API version info for the brokers JMX management interface
*
* As the ServerInformation MBean was only introduced in Qpid JMX API 1.3 it is not possible to use it
* for identifying earlier broker JMX APIs for compatibility purposes. However, this can be accomplished
* by inspecting the 'version' property key of the UserManagement MBean JMX ObjectName. This was first
* introduced in Qpid JMX API 1.2 and so if present in the absence of the ServerInformation MBean
* indicates that version. If it is not present then a null value will be returned upon inspection and
* Qpid JMX API 1.1 can be assumed.
*/
int QPID_JMX_API_MAJOR_VERSION = 1;
int QPID_JMX_API_MINOR_VERSION = 8;
/**
* Attribute to represent the major version number for the management API.
* @return The major management version number.
* @since Qpid JMX API 1.3
*/
@MBeanAttribute(name="ManagementApiMajorVersion",
description = "The major version number for the broker management API")
Integer getManagementApiMajorVersion() throws IOException;
/**
* Attribute to represent the minor version number for the management API.
* @return The minor management version number.
* @since Qpid JMX API 1.3
*/
@MBeanAttribute(name="ManagementApiMinorVersion",
description = "The minor version number for the broker management API")
Integer getManagementApiMinorVersion() throws IOException;
/**
* Attribute to represent the build version string.
* @return The build version string
* @since Qpid JMX API 1.3
*/
@MBeanAttribute(name="BuildVersion",
description = "The repository build version string")
String getBuildVersion() throws IOException;
/**
* Attribute to represent the product version string.
* @return The product version string
* @since Qpid JMX API 1.3
*/
@MBeanAttribute(name="ProductVersion",
description = "The product version string")
String getProductVersion() throws IOException;
/**
* Resets all message and data statistics for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanOperation(name="resetStatistics",
description="Resets all message and data statistics for the broker",
impact= MBeanOperationInfo.ACTION)
void resetStatistics() throws Exception;
/**
* Peak rate of messages per second for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="peakMessageRate", description=TYPE + " Peak Message Rate")
double getPeakMessageRate();
/**
* Peak rate of bytes per second for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="peakDataRate", description=TYPE + " Peak Data Rate")
double getPeakDataRate();
/**
* Rate of messages per second for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="messageRate", description=TYPE + " Message Rate")
double getMessageRate();
/**
* Rate of bytes per second for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="dataRate", description=TYPE + " Data Rate")
double getDataRate();
/**
* Total count of messages for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="totalMessages", description=TYPE + " Total Message Count")
long getTotalMessages();
/**
* Total count of bytes for the broker.
*
* @since Qpid JMX API 1.9
*/
@MBeanAttribute(name="totalData", description=TYPE + " Total Bytes")
long getTotalData();
}
|
