/*
* 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.OMAttribute;
import org.apache.axiom.om.OMElement;
import org.apache.synapse.Mediator;
import org.apache.synapse.SynapseException;
import org.apache.synapse.SynapseConstants;
import org.apache.synapse.mediators.transform.HeaderMediator;
import org.jaxen.JaxenException;
import javax.xml.namespace.QName;
import java.util.Properties;
/**
* Factory for {@link HeaderMediator} instances.
* <p>
* Configuration syntax to set a header:
* <pre>
* <header name="qname" (value="literal" | expression="xpath")/>
* </pre>
*
* Configuration syntax to remove a header:
* <pre>
* <header name="qname" action="remove"/>
* </pre>
*/
public class HeaderMediatorFactory extends AbstractMediatorFactory {
private static final QName HEADER_Q = new QName(XMLConfigConstants.SYNAPSE_NAMESPACE, "header");
private static final QName ATT_ACTION = new QName("action");
protected Mediator createSpecificMediator(OMElement elem, Properties properties) {
HeaderMediator headerMediator = new HeaderMediator();
OMAttribute name = elem.getAttribute(ATT_NAME);
OMAttribute value = elem.getAttribute(ATT_VALUE);
OMAttribute exprn = elem.getAttribute(ATT_EXPRN);
OMAttribute action = elem.getAttribute(ATT_ACTION);
if (name == null || name.getAttributeValue() == null) {
String msg = "A valid name attribute is required for the header mediator";
log.error(msg);
throw new SynapseException(msg);
} else {
String nameAtt = name.getAttributeValue();
int colonPos = nameAtt.indexOf(":");
if (colonPos != -1) {
// has a NS prefix.. find it and the NS it maps into
String prefix = nameAtt.substring(0, colonPos);
String namespaceURI = OMElementUtils.getNameSpaceWithPrefix(prefix, elem);
if (namespaceURI == null) {
handleException("Invalid namespace prefix '" + prefix + "' in name attribute");
} else {
headerMediator.setQName(new QName(namespaceURI, nameAtt.substring(colonPos+1),
prefix));
}
} else {
// no prefix
if (SynapseConstants.HEADER_TO.equals(nameAtt) ||
SynapseConstants.HEADER_FROM.equals(nameAtt) ||
SynapseConstants.HEADER_ACTION.equals(nameAtt) ||
SynapseConstants.HEADER_FAULT.equals(nameAtt) ||
SynapseConstants.HEADER_REPLY_TO.equals(nameAtt) ||
SynapseConstants.HEADER_RELATES_TO.equals(nameAtt)) {
headerMediator.setQName(new QName(nameAtt));
} else {
handleException("Invalid SOAP header: " + nameAtt + " specified at the " +
"header mediator. All SOAP headers must be namespace qualified.");
}
}
}
// after successfully creating the mediator
// set its common attributes such as tracing etc
processAuditStatus(headerMediator,elem);
// The action attribute is optional, if provided and equals to 'remove' the
// header mediator will act as a header remove mediator
if (action != null && "remove".equals(action.getAttributeValue())) {
headerMediator.setAction(HeaderMediator.ACTION_REMOVE);
}
if (headerMediator.getAction() == HeaderMediator.ACTION_SET &&
value == null && exprn == null) {
handleException("A 'value' or 'expression' attribute is required for a [set] " +
"header mediator");
}
if (value != null && value.getAttributeValue() != null) {
headerMediator.setValue(value.getAttributeValue());
} else if (exprn != null && exprn.getAttributeValue() != null) {
try {
headerMediator.setExpression(SynapseXPathFactory.getSynapseXPath(elem, ATT_EXPRN));
} catch (JaxenException je) {
handleException("Invalid XPath expression : " + exprn.getAttributeValue());
}
}
return headerMediator;
}
public QName getTagQName() {
return HEADER_Q;
}
}