MessageStoreSerializer.java
/*
* 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.synapse.config.xml;
import org.apache.axiom.om.OMAbstractFactory;
import org.apache.axiom.om.OMElement;
import org.apache.axiom.om.OMFactory;
import org.apache.axiom.om.OMNamespace;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.synapse.SynapseConstants;
import org.apache.synapse.SynapseException;
import org.apache.synapse.message.store.MessageStore;
import org.apache.synapse.message.store.impl.memory.InMemoryStore;
import org.apache.synapse.util.xpath.SynapseXPath;
import javax.xml.namespace.QName;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
/**
* Serialize an instance of the given Message Store, and sets properties on it.
* <p/>
* <messageStore name="string" class="classname" [sequence = "string" ] >
* <parameter name="string">"string" <parameter>
* <parameter name="string">"string" <parameter>
* <parameter name="string">"string" <parameter>
* </messageStore>
*/
public class MessageStoreSerializer {
private static final Log log = LogFactory.getLog(MessageStoreSerializer.class);
protected static final OMFactory fac = OMAbstractFactory.getOMFactory();
protected static final OMNamespace synNS = SynapseConstants.SYNAPSE_OMNAMESPACE;
protected static final OMNamespace nullNS = fac.createOMNamespace(
XMLConfigConstants.NULL_NAMESPACE, "");
public static OMElement serializeMessageStore(OMElement parent, MessageStore messageStore) {
OMElement store = fac.createOMElement("messageStore", synNS);
if (messageStore != null) {
if (!messageStore.getClass().getName().equals(InMemoryStore.class.getName())) {
store.addAttribute(fac.createOMAttribute("class", nullNS,
messageStore.getClass().getName()));
}
} else {
handleException("Invalid MessageStore. Provider is required");
}
if (messageStore.getName() != null) {
store.addAttribute(fac.createOMAttribute("name", nullNS, messageStore.getName()));
} else {
handleException("Message store Name not specified");
}
if (messageStore.getParameters() != null) {
Iterator iter = messageStore.getParameters().keySet().iterator();
while (iter.hasNext()) {
String name = (String) iter.next();
OMElement property = getParameter(messageStore, name);
store.addChild(property);
}
}
if (getSerializedDescription(messageStore) != null) {
store.addChild(getSerializedDescription(messageStore));
}
if (parent != null) {
parent.addChild(store);
}
return store;
}
/**
* Will get the parameter OMElement.
*
* @param messageStore the message store definition metadata.
* @param name the parameter key.
* @return the parameter OMElement.
*/
private static OMElement getParameter(MessageStore messageStore, String name) {
Object paramValue = messageStore.getParameters().get(name);
OMElement property = null;
if (paramValue instanceof String) {
String value = (String) paramValue;
property = fac.createOMElement("parameter", synNS);
property.addAttribute(fac.createOMAttribute("name", nullNS, name));
if (messageStore.getParameterKey(name) != null) {
property.addAttribute(fac.createOMAttribute("key", nullNS, messageStore.getParameterKey(name)));
} else {
property.setText(value.trim());
}
} else if (paramValue instanceof SynapseXPath) {
SynapseXPath value = (SynapseXPath) paramValue;
String expression = value.getExpression();
Map namespaces = value.getNamespaces();
property = fac.createOMElement("parameter", synNS);
property.addAttribute(fac.createOMAttribute("name", nullNS, name));
property.addAttribute(fac.createOMAttribute("expression", nullNS, expression));
Set<Map.Entry<String, String>> nameSpaceAttributes = namespaces.entrySet();
for (Map.Entry<String, String> nameSpaceElement : nameSpaceAttributes) {
String prefix = nameSpaceElement.getKey();
String uri = nameSpaceElement.getValue();
property.declareNamespace(uri, prefix);
}
}
return property;
}
private static OMElement getSerializedDescription(MessageStore messageStore) {
OMElement descriptionElem = fac.createOMElement(
new QName(SynapseConstants.SYNAPSE_NAMESPACE, "description"));
if (messageStore.getDescription() != null) {
descriptionElem.setText(messageStore.getDescription());
return descriptionElem;
} else {
return null;
}
}
private static void handleException(String msg) {
log.error(msg);
throw new SynapseException(msg);
}
}