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
|
/*
*
* 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.List;
import javax.management.JMException;
import javax.management.MBeanException;
import javax.management.MBeanOperationInfo;
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 ManagedBroker is the management interface to expose management
* features of the Broker.
*
* @author Bhupendra Bhardwaj
* @version 0.1
*/
public interface ManagedBroker
{
static final String TYPE = "VirtualHostManager";
/**
* Returns an array of the exchange types available for creation.
* @since Qpid JMX API 1.3
* @throws IOException
*/
@MBeanAttribute(name="ExchangeTypes", description = "The types of Exchange available for creation.")
String[] getExchangeTypes() throws IOException;
/**
* Returns a list containing the names of the attributes available for the Queue mbeans.
* @since Qpid JMX API 1.3
* @throws IOException
*/
@MBeanOperation(name = "retrieveQueueAttributeNames", description = "Retrieve the attribute names for queues in this virtualhost",
impact = MBeanOperationInfo.INFO)
List<String> retrieveQueueAttributeNames() throws IOException;
/**
* Returns a List of Object Lists containing the requested attribute values (in the same sequence requested) for each queue in the virtualhost.
* If a particular attribute cant be found or raises an mbean/reflection exception whilst being gathered its value is substituted with the String "-".
* @since Qpid JMX API 1.3
* @throws IOException
*/
@MBeanOperation(name = "retrieveQueueAttributeValues", description = "Retrieve the indicated attributes for queues in this virtualhost",
impact = MBeanOperationInfo.INFO)
List<List<Object>> retrieveQueueAttributeValues(@MBeanOperationParameter(name="attributes", description="Attributes to retrieve") String[] attributes) throws IOException;
/**
* Creates a new Exchange.
*
* @param name
* @param type
* @param durable
* @throws IOException
* @throws JMException
* @throws MBeanException
*/
@MBeanOperation(name="createNewExchange", description="Creates a new Exchange", impact= MBeanOperationInfo.ACTION)
void createNewExchange(@MBeanOperationParameter(name="name", description="Name of the new exchange")String name,
@MBeanOperationParameter(name="ExchangeType", description="Type of the exchange")String type,
@MBeanOperationParameter(name="durable", description="true if the Exchang should be durable")boolean durable)
throws IOException, JMException, MBeanException;
/**
* unregisters all the channels, queuebindings etc and unregisters
* this exchange from managed objects.
*
* @param exchange
* @throws IOException
* @throws JMException
* @throws MBeanException
*/
@MBeanOperation(name="unregisterExchange",
description="Unregisters all the related channels and queuebindings of this exchange",
impact= MBeanOperationInfo.ACTION)
void unregisterExchange(@MBeanOperationParameter(name= ManagedExchange.TYPE, description="Exchange Name")String exchange)
throws IOException, JMException, MBeanException;
/**
* Create a new Queue on the Broker server.
*
* @param queueName
* @param durable
* @param owner
* @throws IOException
* @throws JMException
* @throws MBeanException
*/
@MBeanOperation(name="createNewQueue", description="Create a new Queue on the Broker server", impact= MBeanOperationInfo.ACTION)
void createNewQueue(@MBeanOperationParameter(name="queue name", description="Name of the new queue")String queueName,
@MBeanOperationParameter(name="owner", description="Owner name")String owner,
@MBeanOperationParameter(name="durable", description="true if the queue should be durable")boolean durable)
throws IOException, JMException, MBeanException;
/**
* Unregisters the Queue bindings, removes the subscriptions and unregisters
* from the managed objects.
*
* @param queueName
* @throws IOException
* @throws JMException
* @throws MBeanException
*/
@MBeanOperation(name="deleteQueue",
description="Unregisters the Queue bindings, removes the subscriptions and deletes the queue",
impact= MBeanOperationInfo.ACTION)
void deleteQueue(@MBeanOperationParameter(name= ManagedQueue.TYPE, description="Queue Name")String queueName)
throws IOException, JMException, MBeanException;
}
|
