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
|
/*
*
* 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.protocol;
import org.apache.qpid.server.management.MBeanOperationParameter;
import org.apache.qpid.server.management.MBeanAttribute;
import org.apache.qpid.server.management.MBeanOperation;
import javax.management.openmbean.TabularData;
import javax.management.JMException;
import javax.management.MBeanOperationInfo;
import java.util.Date;
import java.io.IOException;
/**
* The management interface exposed to allow management of Connections.
* @author Bhupendra Bhardwaj
* @version 0.1
*/
public interface ManagedConnection
{
static final String TYPE = "Connection";
/**
* channel details of all the channels opened for this connection.
* @return general channel details
* @throws IOException
* @throws JMException
*/
@MBeanAttribute(name="Channels",
description="channel details of all the channels opened for this connection")
TabularData getChannels() throws IOException, JMException;
/**
* 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 remote address of this connection.
* @return remote address
*/
@MBeanAttribute(name="RemoteAddress",
description="The remote address of this connection")
String getRemoteAddress();
/**
* 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();
/**
* Tells the maximum number of channels that can be opened using
* this connection. This is useful in setting notifications or
* taking required action is there are more channels being created.
* @return maximum number of channels allowed to be created.
*/
Long getMaximumNumberOfAllowedChannels();
/**
* Sets the maximum number of channels allowed to be created using
* this connection.
* @param value
*/
@MBeanAttribute(name="MaximumNumberOfAllowedChannels",
description="The maximum number of channels that can be opened using this connection")
void setMaximumNumberOfAllowedChannels(Long value);
//********** Operations *****************//
/**
* 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;
/**
* Unsubscribes the consumers and unregisters the channel from managed objects.
*/
@MBeanOperation(name="closeChannel",
description="Closes the channel with given channeld and" +
"connected consumers will be unsubscribed",
impact= MBeanOperationInfo.ACTION)
void closeChannel(@MBeanOperationParameter(name="channel Id", description="channel Id")int channelId)
throws Exception;
/**
* Commits the transactions if the channel is transactional.
* @param channelId
* @throws JMException
*/
@MBeanOperation(name="commitTransaction",
description="Commits the transactions for given channelID, 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 channelId, if the channel is transactional",
impact= MBeanOperationInfo.ACTION)
void rollbackTransactions(@MBeanOperationParameter(name="channel Id", description="channel Id")int channelId) throws JMException;
}
|
