/*
* JBoss, Home of Professional Open Source.
* Copyright 2011, 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.server.parsing;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.NAMESPACES;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.SCHEMA_LOCATIONS;
import static org.jboss.as.controller.parsing.ParseUtils.invalidAttributeValue;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import javax.xml.stream.XMLStreamException;
import org.jboss.as.controller.SimpleAttributeDefinition;
import org.jboss.as.controller.operations.common.NamespaceAddHandler;
import org.jboss.as.controller.operations.common.SchemaLocationAddHandler;
import org.jboss.as.controller.parsing.Attribute;
import org.jboss.as.controller.parsing.Element;
import org.jboss.as.controller.parsing.Namespace;
import org.jboss.as.controller.parsing.WriteUtils;
import org.jboss.as.controller.persistence.ModelMarshallingContext;
import org.jboss.as.server.services.net.SocketBindingGroupResourceDefinition;
import org.jboss.dmr.ModelNode;
import org.jboss.dmr.Property;
import org.jboss.staxmapper.XMLElementReader;
import org.jboss.staxmapper.XMLElementWriter;
import org.jboss.staxmapper.XMLExtendedStreamReader;
import org.jboss.staxmapper.XMLExtendedStreamWriter;
/**
* Bits of parsing and marshalling logic that are common across more than one of standalone.xml, domain.xml and host.xml.
*
* Note: On adding version specific parse methods to this class these MUST be private and the existing non-versioned method
* handle the version switch. This class is used by WildFly so we need to ensure the methods made accessible are those
* that can be used and will not be renamed.
*
* @author <a href="mailto:david.lloyd@redhat.com">David M. Lloyd</a>
* @author <a href="mailto:darran.lofthouse@jboss.com">Darran Lofthouse</a>
*/
public abstract class CommonXml implements XMLElementReader<List<ModelNode>>, XMLElementWriter<ModelMarshallingContext> {
/*
* When subsequent major versions are added these will be forked and loaded on-demand, may be better to make it
* on-demand immediately as if the config does not contain the item the parsing code will not need to be loaded.
*/
private final DeploymentOverlaysXml deploymentOverlaysXml = new DeploymentOverlaysXml();
private final DeploymentsXml deploymentsXml = new DeploymentsXml();
private final InterfacesXml interfacesXml = new InterfacesXml();
private final PathsXml pathsXml = new PathsXml();
private final SocketBindingsXml socketBindingsXml;
private final SystemPropertiesXml systemPropertiesXml = new SystemPropertiesXml();
private final VaultXml vaultXml = new VaultXml();
protected CommonXml(SocketBindingsXml socketBindingsXml) {
this.socketBindingsXml = socketBindingsXml;
}
/**
* @deprecated @deprecated WFCORE-726 Only here for AppClientXml in Full while waiting for a core release
*/
@Deprecated
protected CommonXml() {
socketBindingsXml = new SocketBindingsXml() {
@Override
protected void writeExtraAttributes(XMLExtendedStreamWriter writer, ModelNode bindingGroup) throws XMLStreamException {
SocketBindingGroupResourceDefinition.PORT_OFFSET.marshallAsAttribute(bindingGroup, writer);
}
};
}
protected void parseNamespaces(final XMLExtendedStreamReader reader, final ModelNode address, final List<ModelNode> nodes) {
final int namespaceCount = reader.getNamespaceCount();
for (int i = 0; i < namespaceCount; i++) {
String prefix = reader.getNamespacePrefix(i);
// FIXME - remove once STXM-8 is released
if (prefix != null && prefix.length() > 0) {
nodes.add(NamespaceAddHandler.getAddNamespaceOperation(address, prefix, reader.getNamespaceURI(i)));
}
}
}
protected void parseSchemaLocations(final XMLExtendedStreamReader reader, final ModelNode address,
final List<ModelNode> updateList, final int idx) throws XMLStreamException {
final List<String> elements = reader.getListAttributeValue(idx);
final List<String> values = new ArrayList<String>();
for (String element : elements) {
if (!element.trim().isEmpty()) {
values.add(element);
}
}
if ((values.size() & 1) != 0) {
throw invalidAttributeValue(reader, idx);
}
final Iterator<String> it = values.iterator();
while (it.hasNext()) {
String key = it.next();
String val = it.next();
if (key.length() > 0 && val.length() > 0) {
updateList.add(SchemaLocationAddHandler.getAddSchemaLocationOperation(address, key, val));
}
}
}
protected void writeSchemaLocation(final XMLExtendedStreamWriter writer, final ModelNode modelNode)
throws XMLStreamException {
if (!modelNode.hasDefined(SCHEMA_LOCATIONS)) {
return;
}
final StringBuilder b = new StringBuilder();
final Iterator<ModelNode> iterator = modelNode.get(SCHEMA_LOCATIONS).asList().iterator();
while (iterator.hasNext()) {
final ModelNode location = iterator.next();
final Property property = location.asProperty();
b.append(property.getName()).append(' ').append(property.getValue().asString());
if (iterator.hasNext()) {
b.append(' ');
}
}
if (b.length() > 0) {
writer.writeAttribute(Namespace.XML_SCHEMA_INSTANCE.getUriString(), Attribute.SCHEMA_LOCATION.getLocalName(),
b.toString());
}
}
protected void writeNamespaces(final XMLExtendedStreamWriter writer, final ModelNode modelNode) throws XMLStreamException {
final boolean needXsd = modelNode.hasDefined(SCHEMA_LOCATIONS) && modelNode.get(SCHEMA_LOCATIONS).asInt() > 0;
final boolean hasNamespaces = modelNode.hasDefined(NAMESPACES);
if (!needXsd && !hasNamespaces) {
return;
}
boolean wroteXsd = false;
final String xsdUri = Namespace.XML_SCHEMA_INSTANCE.getUriString();
if (hasNamespaces) {
for (final Property property : modelNode.get(NAMESPACES).asPropertyList()) {
final String uri = property.getValue().asString();
writer.writeNamespace(property.getName(), uri);
if (!wroteXsd && xsdUri.equals(uri)) {
wroteXsd = true;
}
}
}
if (needXsd && !wroteXsd) {
writer.writeNamespace("xsd", xsdUri);
}
}
/**
* @deprecated {@see WriteUtils#writeElement(XMLExtendedStreamWriter, Element)}
*/
@Deprecated
protected static void writeElement(final XMLExtendedStreamWriter writer, final Element element) throws XMLStreamException {
WriteUtils.writeElement(writer, element);
}
protected void writePaths(final XMLExtendedStreamWriter writer, final ModelNode node, final boolean namedPath) throws XMLStreamException {
pathsXml.writePaths(writer, node, namedPath);
}
protected void parsePaths(final XMLExtendedStreamReader reader, final ModelNode address, final Namespace expectedNs, final List<ModelNode> list,
final boolean requirePath) throws XMLStreamException {
pathsXml.parsePaths(reader, address, expectedNs, list, requirePath);
}
protected void parseSystemProperties(final XMLExtendedStreamReader reader, final ModelNode address, final Namespace expectedNs,
final List<ModelNode> updates, boolean standalone) throws XMLStreamException {
systemPropertiesXml.parseSystemProperties(reader, address, expectedNs, updates, standalone);
}
protected void parseInterfaces(final XMLExtendedStreamReader reader, final Set<String> names, final ModelNode address,
final Namespace expectedNs, final List<ModelNode> list, final boolean checkSpecified) throws XMLStreamException {
interfacesXml.parseInterfaces(reader, names, address, expectedNs, list, checkSpecified);
}
protected void parseSocketBindingGroupRef(final XMLExtendedStreamReader reader, final ModelNode addOperation,
final SimpleAttributeDefinition socketBindingGroup,
final SimpleAttributeDefinition portOffset,
final SimpleAttributeDefinition defaultInterface) throws XMLStreamException {
socketBindingsXml.parseSocketBindingGroupRef(reader, addOperation, socketBindingGroup, portOffset, defaultInterface);
}
protected String parseSocketBinding(final XMLExtendedStreamReader reader, final Set<String> interfaces,
final ModelNode address, final List<ModelNode> updates) throws XMLStreamException {
return socketBindingsXml.parseSocketBinding(reader, interfaces, address, updates);
}
protected String parseOutboundSocketBinding(final XMLExtendedStreamReader reader, final Set<String> interfaces,
final ModelNode address, final List<ModelNode> updates) throws XMLStreamException {
return socketBindingsXml.parseOutboundSocketBinding(reader, interfaces, address, updates);
}
public void parseDeployments(final XMLExtendedStreamReader reader, final ModelNode address, final Namespace expectedNs,
final List<ModelNode> list, final Set<Attribute> allowedAttributes, final Set<Element> allowedElements,
boolean validateUniqueRuntimeNames) throws XMLStreamException {
deploymentsXml.parseDeployments(reader, address, expectedNs, list, allowedAttributes, allowedElements, validateUniqueRuntimeNames);
}
protected void parseDeploymentOverlays(final XMLExtendedStreamReader reader, final Namespace namespace, final ModelNode baseAddress, final List<ModelNode> list, final boolean allowContent, final boolean allowDeployment) throws XMLStreamException {
deploymentOverlaysXml.parseDeploymentOverlays(reader, namespace, baseAddress, list, allowContent, allowDeployment);
}
protected void parseVault(final XMLExtendedStreamReader reader, final ModelNode address, final Namespace expectedNs, final List<ModelNode> list) throws XMLStreamException {
vaultXml.parseVault(reader, address, expectedNs, list);
}
/**
* Write the interfaces including the criteria elements.
*
* @param writer the xml stream writer
* @param modelNode the model
* @throws XMLStreamException
*/
protected void writeInterfaces(final XMLExtendedStreamWriter writer, final ModelNode modelNode) throws XMLStreamException {
interfacesXml.writeInterfaces(writer, modelNode);
}
protected void writeSocketBindingGroup(XMLExtendedStreamWriter writer, ModelNode bindingGroup, boolean fromServer)
throws XMLStreamException {
socketBindingsXml.writeSocketBindingGroup(writer, bindingGroup);
}
protected void writeProperties(final XMLExtendedStreamWriter writer, final ModelNode modelNode, Element element,
boolean standalone) throws XMLStreamException {
systemPropertiesXml.writeProperties(writer, modelNode, element, standalone);
}
/**
* @deprecated {@see WriteUtils#writeAttribute(XMLExtendedStreamWriter, Attribute, String)}
*/
@Deprecated
protected static void writeAttribute(XMLExtendedStreamWriter writer, Attribute attribute, String value)
throws XMLStreamException {
WriteUtils.writeAttribute(writer, attribute, value);
}
protected static void writeContentItem(final XMLExtendedStreamWriter writer, final ModelNode contentItem)
throws XMLStreamException {
DeploymentsXml.writeContentItem(writer, contentItem);
}
protected void writeVault(XMLExtendedStreamWriter writer, ModelNode vault) throws XMLStreamException {
vaultXml.writeVault(writer, vault);
}
/**
* @deprecated {@see WriteUtils#writeNewLine(XMLExtendedStreamWriter)}
*/
@Deprecated
protected static void writeNewLine(XMLExtendedStreamWriter writer) throws XMLStreamException {
WriteUtils.writeNewLine(writer);
}
protected void writeDeploymentOverlays(final XMLExtendedStreamWriter writer, final ModelNode modelNode) throws XMLStreamException {
deploymentOverlaysXml.writeDeploymentOverlays(writer, modelNode);
}
}