summaryrefslogtreecommitdiff
path: root/java/broker/src/main/java/org/apache/qpid/server/management/DefaultManagedObject.java
blob: cd0d58acdbfe8ba847dbd417cc664821f7c4afb7 (plain)
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
/*
 *
 * Copyright (c) 2006 The Apache Software Foundation
 *
 * Licensed 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.management;

import org.apache.qpid.AMQException;
import org.apache.qpid.server.registry.ApplicationRegistry;

import javax.management.JMException;
import javax.management.MalformedObjectNameException;
import javax.management.NotCompliantMBeanException;
import javax.management.ObjectName;
import javax.management.StandardMBean;

/**
 * Provides implementation of the boilerplate ManagedObject interface. Most managed objects should find it useful
 * to extend this class rather than implementing ManagedObject from scratch.
 *
 */
public abstract class DefaultManagedObject extends StandardMBean implements ManagedObject
{
    private Class<?> _managementInterface;

    private String _typeName;

    protected DefaultManagedObject(Class<?> managementInterface, String typeName)
        throws NotCompliantMBeanException
    {
        super(managementInterface);
        _managementInterface = managementInterface;
        _typeName = typeName;
    }

    public String getType()
    {
        return _typeName;
    }

    public Class<?> getManagementInterface()
    {
        return _managementInterface;
    }

    public ManagedObject getParentObject()
    {
        return null;
    }

    public void register() throws AMQException
    {
        try
        {
            ApplicationRegistry.getInstance().getManagedObjectRegistry().registerObject(this);
        }
        catch (JMException e)
        {
            throw new AMQException("Error registering managed object " + this + ": " + e, e);
        }
    }

    public void unregister() throws AMQException
    {
        try
        {
            ApplicationRegistry.getInstance().getManagedObjectRegistry().unregisterObject(this);
        }
        catch (JMException e)
        {
            throw new AMQException("Error unregistering managed object: " + this + ": " + e, e);
        }
    }

    public String toString()
    {
        return getObjectInstanceName() + "[" + getType() + "]";
    }

    /**
     * Created the ObjectName as per the JMX Specs
     * @return ObjectName
     * @throws MalformedObjectNameException
     */
    public ObjectName getObjectName()
        throws MalformedObjectNameException
    {
        String name = getObjectInstanceName();
        StringBuffer objectName = new StringBuffer(ManagedObject.DOMAIN);

        objectName.append(":type=");
        objectName.append(getHierarchicalType(this));

        objectName.append(",");
        objectName.append(getHierarchicalName(this));
        objectName.append("name=").append(name);

        return new ObjectName(objectName.toString());
    }

    private String getHierarchicalType(ManagedObject obj)
    {
        String parentType = null;
        if (obj.getParentObject() != null)
        {
            parentType = getHierarchicalType(obj.getParentObject()).toString();
            return parentType + "." + obj.getType();
        }
        else
            return obj.getType();
    }

    private String getHierarchicalName(ManagedObject obj)
    {
        String parentName = null;
        if (obj.getParentObject() != null)
        {
            parentName = obj.getParentObject().getType() + "=" +
                         obj.getParentObject().getObjectInstanceName() + ","+
                         getHierarchicalName(obj.getParentObject());

            return parentName;
        }
        else
            return "";
    }

    protected static StringBuffer jmxEncode(StringBuffer jmxName, int attrPos)
    {
        for (int i = attrPos; i < jmxName.length(); i++)
        {
            if (jmxName.charAt(i) == ',')
            {
                jmxName.setCharAt(i, ';');
            }
            else if (jmxName.charAt(i) == ':')
            {
                jmxName.setCharAt(i, '-');
            }
            else if (jmxName.charAt(i) == '?' ||
                    jmxName.charAt(i) == '*' ||
                    jmxName.charAt(i) == '\\')
            {
                jmxName.insert(i, '\\');
                i++;
            }
            else if (jmxName.charAt(i) == '\n')
            {
                jmxName.insert(i, '\\');
                i++;
                jmxName.setCharAt(i, 'n');
            }
        }
        return jmxName;
    }
}