package org.opendaylight.controller.netconf.impl.mapping.operations;
+import com.google.common.base.Preconditions;
import java.io.InputStream;
-import java.util.Map;
-
import org.opendaylight.controller.netconf.api.NetconfDocumentedException;
-import org.opendaylight.controller.netconf.api.NetconfOperationRouter;
-import org.opendaylight.controller.netconf.impl.DefaultCommitNotificationProducer;
+import org.opendaylight.controller.netconf.api.xml.XmlNetconfConstants;
+import org.opendaylight.controller.netconf.impl.CommitNotifier;
import org.opendaylight.controller.netconf.impl.mapping.CapabilityProvider;
-import org.opendaylight.controller.netconf.mapping.api.NetconfOperationFilter;
-import org.opendaylight.controller.netconf.mapping.api.NetconfOperationFilterChain;
-import org.opendaylight.controller.netconf.util.mapping.AbstractNetconfOperation.OperationNameAndNamespace;
+import org.opendaylight.controller.netconf.impl.osgi.NetconfOperationRouter;
+import org.opendaylight.controller.netconf.mapping.api.HandlingPriority;
+import org.opendaylight.controller.netconf.mapping.api.NetconfOperationChainedExecution;
+import org.opendaylight.controller.netconf.util.mapping.AbstractNetconfOperation;
import org.opendaylight.controller.netconf.util.xml.XmlElement;
-import org.opendaylight.controller.netconf.util.xml.XmlNetconfConstants;
import org.opendaylight.controller.netconf.util.xml.XmlUtil;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
-import com.google.common.collect.Maps;
-
-public class DefaultCommit implements NetconfOperationFilter {
+public class DefaultCommit extends AbstractNetconfOperation {
- private static final Logger logger = LoggerFactory.getLogger(DefaultCommit.class);
+ private static final Logger LOG = LoggerFactory.getLogger(DefaultCommit.class);
private static final String NOTIFY_ATTR = "notify";
- private final DefaultCommitNotificationProducer notificationProducer;
+ private final CommitNotifier notificationProducer;
private final CapabilityProvider cap;
- private final String netconfSessionIdForReporting;
+ private final NetconfOperationRouter operationRouter;
- public DefaultCommit(DefaultCommitNotificationProducer notifier, CapabilityProvider cap,
- String netconfSessionIdForReporting) {
+ public DefaultCommit(CommitNotifier notifier, CapabilityProvider cap,
+ String netconfSessionIdForReporting, NetconfOperationRouter netconfOperationRouter) {
+ super(netconfSessionIdForReporting);
this.notificationProducer = notifier;
this.cap = cap;
- this.netconfSessionIdForReporting = netconfSessionIdForReporting;
+ this.operationRouter = netconfOperationRouter;
this.getConfigMessage = loadGetConfigMessage();
}
}
@Override
- public Document doFilter(Document message, NetconfOperationRouter operationRouter,
- NetconfOperationFilterChain filterChain) throws NetconfDocumentedException {
- OperationNameAndNamespace operationNameAndNamespace = new OperationNameAndNamespace(message);
- if (canHandle(operationNameAndNamespace)) {
- if (isCommitWithoutNotification(message)) {
- message = removePersisterAttributes(message);
- logger.debug("Skipping commit notification");
- // fall back to filter chain
- } else {
- Document innerResult = filterChain.execute(message, operationRouter);
- Element cfgSnapshot = getConfigSnapshot(operationRouter);
- logger.debug("Config snapshot retrieved successfully {}", cfgSnapshot);
- notificationProducer.sendCommitNotification("ok", cfgSnapshot, cap.getCapabilities());
- return innerResult;
- }
- }
- return filterChain.execute(message, operationRouter);
+ protected String getOperationName() {
+ return XmlNetconfConstants.COMMIT;
}
@Override
- public int getSortingOrder() {
- return 0;
+ public Document handle(Document requestMessage, NetconfOperationChainedExecution subsequentOperation) throws NetconfDocumentedException {
+ Preconditions.checkArgument(!subsequentOperation.isExecutionTermination(),
+ "Subsequent netconf operation expected by %s", this);
+
+ if (isCommitWithoutNotification(requestMessage)) {
+ LOG.debug("Skipping commit notification");
+ } else {
+ // Send commit notification if commit was not issued by persister
+ removePersisterAttributes(requestMessage);
+ Element cfgSnapshot = getConfigSnapshot(operationRouter);
+ LOG.debug("Config snapshot retrieved successfully {}", cfgSnapshot);
+ notificationProducer.sendCommitNotification("ok", cfgSnapshot, cap.getCapabilities());
+ }
+
+ return subsequentOperation.execute(requestMessage);
}
@Override
- public int compareTo(NetconfOperationFilter o) {
- return Integer.compare(getSortingOrder(), o.getSortingOrder());
+ protected Element handle(Document document, XmlElement message, NetconfOperationChainedExecution subsequentOperation) throws NetconfDocumentedException {
+ throw new UnsupportedOperationException("Never gets called");
}
- private boolean canHandle(OperationNameAndNamespace operationNameAndNamespace) {
- if (operationNameAndNamespace.getOperationName().equals("commit") == false)
- return false;
- return operationNameAndNamespace.getNamespace().equals(
- XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+ @Override
+ protected HandlingPriority getHandlingPriority() {
+ return HandlingPriority.HANDLE_WITH_DEFAULT_PRIORITY.increasePriority(1);
}
- private Document removePersisterAttributes(Document message) {
- final Element documentElement = message.getDocumentElement();
- documentElement.removeAttribute(NOTIFY_ATTR);
- return message;
+ private void removePersisterAttributes(Document message) {
+ message.getDocumentElement().removeAttribute(NOTIFY_ATTR);
}
private boolean isCommitWithoutNotification(Document message) {
- XmlElement xmlElement = XmlElement.fromDomElementWithExpected(message.getDocumentElement(),
- XmlNetconfConstants.RPC_KEY, XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+ XmlElement xmlElement = null;
+ try {
+ xmlElement = XmlElement.fromDomElementWithExpected(message.getDocumentElement(),
+ XmlNetconfConstants.RPC_KEY, XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+ } catch (NetconfDocumentedException e) {
+ LOG.trace("Commit operation is not valid due to ",e);
+ return false;
+ }
String attr = xmlElement.getAttribute(NOTIFY_ATTR);
- if (attr == null || attr.equals(""))
+ if (attr == null || attr.equals("")){
return false;
- else if (attr.equals(Boolean.toString(false))) {
- logger.debug("Commit operation received with notify=false attribute {}", message);
+ } else if (attr.equals(Boolean.toString(false))) {
+ LOG.debug("Commit operation received with notify=false attribute {}", message);
return true;
} else {
return false;
getConfigMessage, null);
XmlElement dataElement;
- try {
- XmlElement xmlElement = XmlElement.fromDomElementWithExpected(responseDocument.getDocumentElement(),
- XmlNetconfConstants.RPC_REPLY_KEY, XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
- dataElement = xmlElement.getOnlyChildElement(XmlNetconfConstants.DATA_KEY);
- } catch (IllegalArgumentException e) {
- final String msg = "Unexpected response from get-config operation";
- logger.warn(msg, e);
- Map<String, String> info = Maps.newHashMap();
- info.put(NetconfDocumentedException.ErrorTag.operation_failed.toString(), e.getMessage());
- throw new NetconfDocumentedException(msg, e, NetconfDocumentedException.ErrorType.application,
- NetconfDocumentedException.ErrorTag.operation_failed,
- NetconfDocumentedException.ErrorSeverity.error, info);
- }
-
+ XmlElement xmlElement = XmlElement.fromDomElementWithExpected(responseDocument.getDocumentElement(),
+ XmlNetconfConstants.RPC_REPLY_KEY, XmlNetconfConstants.URN_IETF_PARAMS_XML_NS_NETCONF_BASE_1_0);
+ dataElement = xmlElement.getOnlyChildElement(XmlNetconfConstants.DATA_KEY);
return dataElement.getDomElement();
}
- @Override
- public String toString() {
- return "DefaultCommit{" + netconfSessionIdForReporting + '}';
- }
}