/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and others contributors as indicated
* by the @authors tag. All rights reserved.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* 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,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
package org.jboss.soa.esb.listeners.config.mappers120;
import java.util.List;
import org.apache.xmlbeans.XmlCursor;
import org.apache.xmlbeans.XmlObject;
import org.apache.xmlbeans.XmlCursor.TokenType;
import org.jboss.soa.esb.ConfigurationException;
import org.jboss.soa.esb.dom.YADOMUtil;
import org.jboss.soa.esb.listeners.ListenerTagNames;
import org.jboss.soa.esb.listeners.config.xbeanmodel120.*;
import org.jboss.soa.esb.listeners.config.xbeanmodel120.PropertyDocument.Property;
import org.jboss.soa.esb.listeners.config.xbeanmodel120.ServiceDocument.Service;
import org.jboss.soa.esb.listeners.message.MessageAwareListener;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
/**
* Mapper utility methods.
* @author <a href="mailto:tom.fennelly@jboss.com">tom.fennelly@jboss.com</a>
*/
public abstract class MapperUtil {
/**
* Map all default listener attributes onto the target listener ConfigTree.
* @param listener The listener configuration instance.
* @param listenerNode The target DOM ConfigTree listener element.
* @param model The model.
*/
protected static void mapDefaultAttributes(Listener listener, Element listenerNode, XMLBeansModel model) {
Service service = model.getService(listener);
boolean isGateway = XMLBeansModel.isGateway(listener);
if(listener instanceof DualListener) {
listenerNode.setAttribute(ListenerTagNames.MAX_THREADS_TAG, String.valueOf(((DualListener)listener).getMaxThreads()));
} else {
listenerNode.setAttribute(ListenerTagNames.MAX_THREADS_TAG, "1");
}
mapListenerServiceAttributes(listenerNode, service, isGateway);
if (!isGateway && !listenerNode.hasAttribute(ListenerTagNames.LISTENER_CLASS_TAG)) {
listenerNode.setAttribute(ListenerTagNames.LISTENER_CLASS_TAG, MessageAwareListener.class.getName());
}
ActionsDocument.Actions actions = service.getActions();
if(actions != null) {
MepType.Enum mep = actions.getMep();
if(mep != null) {
// Intentionally not setting a default of RequestResponse because the action pipeline
// has a "defaultProcessing" state that exists if the mep is not set (dubious??)....
listenerNode.setAttribute(ListenerTagNames.MEP_ATTRIBUTE_TAG, mep.toString());
}
}
String busIdRef = listener.getBusidref();
if(busIdRef != null) {
listenerNode.setAttribute(ListenerTagNames.BUSIDREF_ATTRIBUTE_TAG, busIdRef);
}
}
/**
* Map the Service specific attributes onto the listener configuration.
* @param listenerNode The listener config node.
* @param service The Service details (from the model).
* @param isGateway True if the listener is a gateway, otherwise false.
*/
public static void mapListenerServiceAttributes(Element listenerNode, Service service, boolean isGateway) {
listenerNode.setAttribute(ListenerTagNames.SERVICE_DESCRIPTION_TAG, service.getDescription());
if (isGateway) {
listenerNode.setAttribute(ListenerTagNames.TARGET_SERVICE_CATEGORY_TAG, service.getCategory());
listenerNode.setAttribute(ListenerTagNames.TARGET_SERVICE_NAME_TAG, service.getName());
} else {
listenerNode.setAttribute(ListenerTagNames.SERVICE_CATEGORY_NAME_TAG, service.getCategory());
listenerNode.setAttribute(ListenerTagNames.SERVICE_NAME_TAG, service.getName());
}
if (service.getAlertTimeThreshold() != null) {
listenerNode.setAttribute(ListenerTagNames.SERVICE_ALERT_TIME_TAG, service.getAlertTimeThreshold().toString());
}
if (service.getAlertLengthThreshold() != null) {
listenerNode.setAttribute(ListenerTagNames.SERVICE_ALERT_LENGTH_TAG, service.getAlertLengthThreshold().toString());
}
}
/**
* Map all the properties targeted at the supplied listener onto the target element.
* <p/>
* This involves copying the properties from the associated bus and provider nodes.
* @param listener The listener config instance.
* @param target The target DOM ConfigTree listener element.
* @param model The model.
* @throws org.jboss.soa.esb.ConfigurationException Bad bis configuration.
*/
protected static void mapEPRProperties(Listener listener, Element target, XMLBeansModel model) throws ConfigurationException {
Bus bus = model.getBus(listener.getBusidref());
Provider provider = model.getProvider(bus);
// Map the properties from the provider config...
mapProperties(provider.getPropertyList(), target);
// Map the properties from the bus config...
mapProperties(bus.getPropertyList(), target);
}
/**
* Map all the supplied properties onto the target element.
* @param target The target DOM element.
* @param properties The properties to be mapped.
*/
public static void mapProperties(List<Property> properties, Element target) {
// Map the property elements to actions attributes...
for(Property property : properties) {
Element propertyElement = target.getOwnerDocument().createElement("property");
serialize(property, propertyElement);
if (propertyElement.hasChildNodes())
{
YADOMUtil.copyChildNodes(propertyElement, target);
}
else
{
target.setAttribute(property.getName(), property.getValue());
}
}
}
/**
* Serialise the supplied {@link org.apache.xmlbeans.XmlObject} instance to the supplied element.
* @param xmlObject The XmlObject instance.
* @param toElement The element to which the cursor is to be serialised.
*/
protected static void serialize(XmlObject xmlObject, Element toElement) {
XmlCursor cursor = xmlObject.newCursor();
// Note there are methods on the XmlObject that "looked" as though they might be able
// to do this for us (save, newDomNode etc), but they kept throwing exceptions.
serialize(cursor, toElement);
cursor.dispose();
}
/**
* Serialise the XML content behind the supplied XmlCursor instance to the supplied
* target element.
* @param cursor The cursor instance.
* @param toElement The target DOM Element.
*/
private static void serialize(XmlCursor cursor, Element toElement) {
TokenType token;
Document doc = toElement.getOwnerDocument();
while(true) {
token = cursor.toNextToken();
switch (token.intValue()) {
case TokenType.INT_ATTR:
toElement.setAttribute(cursor.getName().getLocalPart(), cursor.getTextValue());
break;
case TokenType.INT_COMMENT:
toElement.appendChild(doc.createComment(cursor.getTextValue()));
break;
case TokenType.INT_START:
Element childElement = doc.createElement(cursor.getName().getLocalPart());
toElement.appendChild(childElement);
serialize(cursor, childElement);
break;
case TokenType.INT_TEXT:
toElement.appendChild(doc.createTextNode(cursor.getChars()));
break;
case TokenType.INT_END:
case TokenType.INT_STARTDOC:
case TokenType.INT_ENDDOC:
case TokenType.INT_NONE:
return;
case TokenType.INT_PROCINST:
case TokenType.INT_NAMESPACE:
default:
break;
}
}
}
}