summaryrefslogtreecommitdiff
path: root/qpid/java/management/client/src/main/java/org/apache/qpid/management/wsdm/capabilities/RmdBuilder.java
blob: c1678eb43f5ccd33a4106885b732f321d4b9db2e (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
/*
 *
 * 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.wsdm.capabilities;

import java.util.ArrayList;
import java.util.List;

import javax.management.MBeanAttributeInfo;
import javax.management.MBeanOperationInfo;
import javax.management.ObjectName;

import org.apache.muse.core.Environment;
import org.apache.muse.util.xml.XmlUtils;
import org.apache.muse.ws.resource.metadata.WsrmdConstants;
import org.apache.qpid.management.Names;
import org.apache.qpid.qman.debug.WsdlDebugger;
import org.w3c.dom.Element;

/**
 * Resource Metadata Descriptor Builder.
 * It is used for build the metadata descriptor for properties of the 
 * incoming jmx object. 
 * 
 * @author Andrea Gazzarini
 */
class RmdBuilder implements IArtifactBuilder
{
	private List<Element> _metadataDescriptor = new ArrayList<Element>();
	
	ObjectName _objectName;
	
	/**
	 * Nothing to be done here on this builder. 
	 * Simply logs a message indicating the target object name.
	 * 
	 * @param objectName the jmx name of the object that is going to be processed.
	 */
	public void begin(ObjectName objectName)
	{
		this._objectName = objectName;
	}
	
	/**
	 * Nothing to be done here on this builder. 
	 * 
	 * @throws BuilderException never.
	 */
	public void endAttributes()
	{
		// N.A. for this builder.
	}
	
	/**
	 * Nothing to be done here on this builder. 
	 * 
	 * @throws BuilderException never.
	 */
	public void endOperations()
	{
		// N.A. for this builder.
	}

	/**
	 * Process a single attribute metadata.
	 * An attribute (that is, a property) represented by the corresponding incoming 
	 * attribute metadata will generate an wsrmd:Property xml element with the constraints
	 * (initial values, static values, allowed values) contained on the metadata.
	 * 
	 * @param attributeMetadata the attribute (jmx) metadata.
	 */
	public void onAttribute(MBeanAttributeInfo attributeMetadata)
	{
		Element property = XmlUtils.createElement(WsrmdConstants.PROPERTY_QNAME);
		property.setAttribute(Names.NAME_ATTRIBUTE, Names.PREFIX+":"+attributeMetadata.getName());
		property.setAttribute(Names.MODIFIABILITY, 
				attributeMetadata.isWritable() 
					? Names.READ_WRITE 
					: Names.READ_ONLY);
		property.setAttribute(Names.MUTABILITY,Names.MUTABLE);
		
		WsdlDebugger.debug(_objectName, property);
		
		_metadataDescriptor.add(property);
	}

	/**
	 * Nothing to be done here on this builder. 
	 * 
	 * @throws BuilderException never.
	 */	
	public void onOperation(MBeanOperationInfo operation)
	{
		// N.A. for this builder
	}

	/**
	 * Nothing to be done here on this builder. 
	 * 
	 * @throws BuilderException never.
	 */
	public void setEnvironment(Environment environment) 
	{
		// N.A. for this builder
	}

	/**
	 * Nothing to be done here on this builder. 
	 * 
	 * @throws BuilderException never.
	 */
	public Element[] getResourceMetadataDescriptor() 
	{
		Element [] properties = _metadataDescriptor.toArray(
				new Element[_metadataDescriptor.size()]);
		return properties;
	}
}