ManagedObject.java
01 /*
02  *
03  * Licensed to the Apache Software Foundation (ASF) under one
04  * or more contributor license agreements.  See the NOTICE file
05  * distributed with this work for additional information
06  * regarding copyright ownership.  The ASF licenses this file
07  * to you under the Apache License, Version 2.0 (the
08  * "License"); you may not use this file except in compliance
09  * with the License.  You may obtain a copy of the License at
10  
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  */
21 package org.apache.qpid.server.management;
22 
23 import javax.management.MalformedObjectNameException;
24 import javax.management.ObjectName;
25 
26 import org.apache.qpid.AMQException;
27 
28 /**
29  * This should be implemented by all Managable objects.
30  */
31 public interface ManagedObject
32 {
33     static final String DOMAIN = "org.apache.qpid";
34 
35     /**
36      @return the name that uniquely identifies this object instance. It must be
37      * unique only among objects of this type at this level in the hierarchy so
38      * the uniqueness should not be too difficult to ensure.
39      */
40     String getObjectInstanceName();
41 
42     String getType();
43 
44     Class<?> getManagementInterface();
45 
46     ManagedObject getParentObject();
47 
48     void register() throws AMQException;
49 
50     void unregister() throws AMQException;
51 
52     /**
53      * Returns the ObjectName required for the mbeanserver registration.
54      @return ObjectName
55      @throws MalformedObjectNameException
56      */
57     ObjectName getObjectName() throws MalformedObjectNameException;
58 }