/*
* JBoss, Home of Professional Open Source.
* Copyright 2010, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.jmx;
import java.util.Collections;
import java.util.List;
import javax.xml.stream.XMLStreamConstants;
import javax.xml.stream.XMLStreamException;
import org.jboss.as.controller.Extension;
import org.jboss.as.controller.ExtensionContext;
import org.jboss.as.controller.SubsystemRegistration;
import org.jboss.as.controller.descriptions.ResourceDescriptionResolver;
import org.jboss.as.controller.descriptions.StandardResourceDescriptionResolver;
import org.jboss.as.controller.operations.common.GenericSubsystemDescribeHandler;
import org.jboss.as.controller.parsing.ExtensionParsingContext;
import org.jboss.as.controller.parsing.ParseUtils;
import org.jboss.as.controller.persistence.SubsystemMarshallingContext;
import org.jboss.as.controller.registry.ManagementResourceRegistration;
import org.jboss.as.controller.registry.OperationEntry;
import org.jboss.dmr.ModelNode;
import org.jboss.staxmapper.XMLElementReader;
import org.jboss.staxmapper.XMLElementWriter;
import org.jboss.staxmapper.XMLExtendedStreamReader;
import org.jboss.staxmapper.XMLExtendedStreamWriter;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.ADD;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.DESCRIBE;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OP_ADDR;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.SUBSYSTEM;
import static org.jboss.as.jmx.CommonAttributes.JMX;
import static org.jboss.as.jmx.CommonAttributes.REMOTING_CONNECTOR;
/**
* Domain extension used to initialize the JMX subsystem.
*
* @author Emanuel Muckenhuber
* @author Kabir Khan
*/
public class JMXExtension implements Extension {
public static final String SUBSYSTEM_NAME = "jmx";
private static final String RESOURCE_NAME = JMXExtension.class.getPackage().getName() + ".LocalDescriptions";
static ResourceDescriptionResolver getResourceDescriptionResolver(final String keyPrefix) {
return new StandardResourceDescriptionResolver(keyPrefix, RESOURCE_NAME, JMXExtension.class.getClassLoader(), true, false);
}
static final JMXSubsystemParser_1_1 parserCurrent = new JMXSubsystemParser_1_1();
static final JMXSubsystemParser_1_0 parser10 = new JMXSubsystemParser_1_0();
/**
* {@inheritDoc}
*/
@Override
public void initialize(ExtensionContext context) {
final SubsystemRegistration registration = context.registerSubsystem(SUBSYSTEM_NAME, 1, 0);
final boolean registerRuntimeOnly = context.isRuntimeOnlyRegistrationValid();
final ManagementResourceRegistration subsystem = registration.registerSubsystemModel(new JMXSubsystemRootResource());
subsystem.registerOperationHandler(DESCRIBE, GenericSubsystemDescribeHandler.INSTANCE, GenericSubsystemDescribeHandler.INSTANCE, false, OperationEntry.EntryType.PRIVATE);
subsystem.registerSubModel(RemotingConnectorResource.INSTANCE);
registration.registerXMLElementWriter(parserCurrent);
}
/**
* {@inheritDoc}
*/
@Override
public void initializeParsers(ExtensionParsingContext context) {
context.setSubsystemXmlMapping(SUBSYSTEM_NAME, Namespace.JMX_1_0.getUriString(), parser10);
context.setSubsystemXmlMapping(SUBSYSTEM_NAME, Namespace.JMX_1_1.getUriString(), parserCurrent);
}
private static ModelNode createAddOperation(Boolean showModel) {
final ModelNode subsystem = new ModelNode();
subsystem.get(OP).set(ADD);
subsystem.get(OP_ADDR).add(SUBSYSTEM, SUBSYSTEM_NAME);
if (showModel != null) {
subsystem.get(CommonAttributes.SHOW_MODEL).set(showModel.booleanValue());
}
return subsystem;
}
private static class JMXSubsystemParser_1_0 implements XMLStreamConstants, XMLElementReader<List<ModelNode>>, XMLElementWriter<SubsystemMarshallingContext> {
/**
* {@inheritDoc}
*/
@Override
public void readElement(XMLExtendedStreamReader reader, List<ModelNode> list) throws XMLStreamException {
ParseUtils.requireNoAttributes(reader);
list.add(createAddOperation(null));
boolean gotConnector = false;
while (reader.hasNext() && reader.nextTag() != END_ELEMENT) {
final Element element = Element.forName(reader.getLocalName());
switch (element) {
case JMX_CONNECTOR: {
if (gotConnector) {
throw ParseUtils.duplicateNamedElement(reader, Element.JMX_CONNECTOR.getLocalName());
}
parseConnector(reader);
gotConnector = true;
break;
}
default: {
throw ParseUtils.unexpectedElement(reader);
}
}
}
}
void parseConnector(XMLExtendedStreamReader reader) throws XMLStreamException {
JmxLogger.ROOT_LOGGER.jmxConnectorNotSupported();
String serverBinding = null;
String registryBinding = null;
int count = reader.getAttributeCount();
for (int i = 0; i < count; i++) {
final String value = reader.getAttributeValue(i);
final Attribute attribute = Attribute.forName(reader.getAttributeLocalName(i));
switch (attribute) {
case SERVER_BINDING: {
serverBinding = value;
break;
}
case REGISTRY_BINDING: {
registryBinding = value;
break;
}
default: {
throw ParseUtils.unexpectedAttribute(reader, i);
}
}
}
// Require no content
ParseUtils.requireNoContent(reader);
if (serverBinding == null) {
throw ParseUtils.missingRequired(reader, Collections.singleton(Attribute.SERVER_BINDING));
}
if (registryBinding == null) {
throw ParseUtils.missingRequired(reader, Collections.singleton(Attribute.REGISTRY_BINDING));
}
}
/**
* {@inheritDoc}
*/
@Override
public void writeContent(XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException {
Namespace schemaVer = Namespace.CURRENT;
ModelNode node = context.getModelNode();
context.startSubsystemElement(schemaVer.getUriString(), false);
writer.writeEndElement();
}
}
private static class JMXSubsystemParser_1_1 implements XMLStreamConstants, XMLElementReader<List<ModelNode>>, XMLElementWriter<SubsystemMarshallingContext> {
/**
* {@inheritDoc}
*/
@Override
public void readElement(XMLExtendedStreamReader reader, List<ModelNode> list) throws XMLStreamException {
Boolean showModel = null;
ParseUtils.requireNoAttributes(reader);
ModelNode connectorAdd = null;
while (reader.hasNext() && reader.nextTag() != END_ELEMENT) {
final Element element = Element.forName(reader.getLocalName());
switch (element) {
case SHOW_MODEL:
if (showModel != null) {
throw ParseUtils.duplicateNamedElement(reader, Element.SHOW_MODEL.getLocalName());
}
showModel = parseShowModelElement(reader);
break;
case REMOTING_CONNECTOR: {
if (connectorAdd != null) {
throw ParseUtils.duplicateNamedElement(reader, Element.REMOTING_CONNECTOR.getLocalName());
}
connectorAdd = parseRemoteConnector(reader);
break;
}
default: {
throw ParseUtils.unexpectedElement(reader);
}
}
}
list.add(createAddOperation(showModel));
if (connectorAdd != null) {
list.add(connectorAdd);
}
}
private ModelNode parseRemoteConnector(final XMLExtendedStreamReader reader) throws XMLStreamException {
final ModelNode connector = new ModelNode();
connector.get(OP).set(ADD);
connector.get(OP_ADDR).add(SUBSYSTEM).add(JMX);
connector.get(OP_ADDR).add(REMOTING_CONNECTOR).add(CommonAttributes.JMX);
int count = reader.getAttributeCount();
for (int i = 0; i < count; i++) {
final String value = reader.getAttributeValue(i);
final Attribute attribute = Attribute.forName(reader.getAttributeLocalName(i));
switch (attribute) {
case USE_MANAGEMENT_ENDPOINT: {
RemotingConnectorResource.USE_MANAGEMENT_ENDPOINT.parseAndSetParameter(value, connector, reader);
break;
}
default: {
throw ParseUtils.unexpectedAttribute(reader, i);
}
}
}
ParseUtils.requireNoContent(reader);
return connector;
}
boolean parseShowModelElement(XMLExtendedStreamReader reader) throws XMLStreamException {
ParseUtils.requireSingleAttribute(reader, CommonAttributes.VALUE);
return ParseUtils.readBooleanAttributeElement(reader, CommonAttributes.VALUE);
}
/**
* {@inheritDoc}
*/
@Override
public void writeContent(XMLExtendedStreamWriter writer, SubsystemMarshallingContext context) throws XMLStreamException {
Namespace schemaVer = Namespace.CURRENT;
ModelNode node = context.getModelNode();
context.startSubsystemElement(schemaVer.getUriString(), false);
if (node.hasDefined(CommonAttributes.SHOW_MODEL)) {
writer.writeEmptyElement(Element.SHOW_MODEL.getLocalName());
JMXSubsystemRootResource.SHOW_MODEL.marshallAsAttribute(node, writer);
}
if (node.hasDefined(CommonAttributes.REMOTING_CONNECTOR)) {
writer.writeStartElement(Element.REMOTING_CONNECTOR.getLocalName());
final ModelNode resourceModel = node.get(CommonAttributes.REMOTING_CONNECTOR).get(CommonAttributes.JMX);
RemotingConnectorResource.USE_MANAGEMENT_ENDPOINT.marshallAsAttribute(resourceModel, writer);
writer.writeEndElement();
}
writer.writeEndElement();
}
}
}