Bug 510: Implementation of Forwarded Binding Data Broker

[controller.git] / opendaylight / md-sal / sal-binding-broker / src / main / java / org / opendaylight / controller / md / sal / binding / impl / ForwardedBindingDataBroker.java

diff --git a/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/ForwardedBindingDataBroker.java b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/ForwardedBindingDataBroker.java
new file mode 100644 (file)
index 0000000..fb06b13
--- /dev/null
+++ b/opendaylight/md-sal/sal-binding-broker/src/main/java/org/opendaylight/controller/md/sal/binding/impl/ForwardedBindingDataBroker.java
@@ -0,0 +1,145 @@
+/*
+ * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+package org.opendaylight.controller.md.sal.binding.impl;
+
+import org.opendaylight.controller.md.sal.binding.api.BindingDataBroker;
+import org.opendaylight.controller.md.sal.binding.api.BindingDataReadTransaction;
+import org.opendaylight.controller.md.sal.binding.api.BindingDataReadWriteTransaction;
+import org.opendaylight.controller.md.sal.binding.api.BindingDataWriteTransaction;
+import org.opendaylight.controller.md.sal.common.api.TransactionStatus;
+import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
+import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataBroker;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataReadWriteTransaction;
+import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
+import org.opendaylight.yangtools.yang.binding.DataObject;
+import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
+import org.opendaylight.yangtools.yang.common.RpcResult;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
+import org.opendaylight.yangtools.yang.data.impl.codec.BindingIndependentMappingService;
+
+import com.google.common.base.Optional;
+import com.google.common.util.concurrent.ListenableFuture;
+
+/**
+ * The DataBrokerImpl simply defers to the DOMDataBroker for all its operations.
+ * All transactions and listener registrations are wrapped by the DataBrokerImpl
+ * to allow binding aware components to use the DataBroker transparently.
+ *
+ * Besides this the DataBrokerImpl and it's collaborators also cache data that
+ * is already transformed from the binding independent to binding aware format
+ *
+ * TODO : All references in this class to CompositeNode should be switched to
+ * NormalizedNode once the MappingService is updated
+ *
+ */
+public class ForwardedBindingDataBroker extends AbstractForwardedDataBroker implements BindingDataBroker {
+
+    public ForwardedBindingDataBroker(final DOMDataBroker domDataBroker, final BindingIndependentMappingService mappingService) {
+        super(domDataBroker, mappingService);
+    }
+
+    @Override
+    public BindingDataReadTransaction newReadOnlyTransaction() {
+        return new BindingDataReadTransactionImpl(getDelegate().newReadOnlyTransaction(),getCodec());
+    }
+
+    @Override
+    public BindingDataReadWriteTransaction newReadWriteTransaction() {
+        return new BindingDataReadWriteTransactionImpl(getDelegate().newReadWriteTransaction(),getCodec());
+    }
+
+    @Override
+    public BindingDataWriteTransaction newWriteOnlyTransaction() {
+        return new BindingDataWriteTransactionImpl<DOMDataWriteTransaction>(getDelegate().newWriteOnlyTransaction(),getCodec());
+    }
+
+    private abstract class AbstractBindingTransaction<T extends AsyncTransaction<org.opendaylight.yangtools.yang.data.api.InstanceIdentifier, NormalizedNode<?, ?>>>
+            extends AbstractForwardedTransaction<T> implements AsyncTransaction<InstanceIdentifier<?>, DataObject> {
+
+        protected AbstractBindingTransaction(final T delegate, final BindingToNormalizedNodeCodec codec) {
+            super(delegate, codec);
+        }
+
+        @Override
+        public Object getIdentifier() {
+            return getDelegate().getIdentifier();
+        }
+
+        @Override
+        public void close() {
+            getDelegate().close();
+        }
+
+    }
+
+    private class BindingDataReadTransactionImpl extends AbstractBindingTransaction<DOMDataReadTransaction> implements
+            BindingDataReadTransaction {
+
+        protected BindingDataReadTransactionImpl(final DOMDataReadTransaction delegate,
+                final BindingToNormalizedNodeCodec codec) {
+            super(delegate, codec);
+        }
+
+        @Override
+        public ListenableFuture<Optional<DataObject>> read(final LogicalDatastoreType store,
+                final InstanceIdentifier<?> path) {
+            return doRead(getDelegate(), store, path);
+        }
+    }
+
+    private class BindingDataWriteTransactionImpl<T extends DOMDataWriteTransaction> extends
+            AbstractBindingTransaction<T> implements BindingDataWriteTransaction {
+
+        protected BindingDataWriteTransactionImpl(final T delegate, final BindingToNormalizedNodeCodec codec) {
+            super(delegate, codec);
+
+        }
+
+        @Override
+        public void cancel() {
+            doCancel(getDelegate());
+        }
+
+        @Override
+        public void put(final LogicalDatastoreType store, final InstanceIdentifier<?> path, final DataObject data) {
+            doPut(getDelegate(), store, path, data);
+        }
+
+        @Override
+        public void merge(final LogicalDatastoreType store, final InstanceIdentifier<?> path, final DataObject data) {
+            doMerge(getDelegate(), store, path, data);
+        }
+
+        @Override
+        public void delete(final LogicalDatastoreType store, final InstanceIdentifier<?> path) {
+            doDelete(getDelegate(), store, path);
+        }
+
+        @Override
+        public ListenableFuture<RpcResult<TransactionStatus>> commit() {
+            return doCommit(getDelegate());
+        }
+    }
+
+    private class BindingDataReadWriteTransactionImpl extends
+            BindingDataWriteTransactionImpl<DOMDataReadWriteTransaction> implements BindingDataReadWriteTransaction {
+
+        protected BindingDataReadWriteTransactionImpl(final DOMDataReadWriteTransaction delegate,
+                final BindingToNormalizedNodeCodec codec) {
+            super(delegate, codec);
+        }
+
+        @Override
+        public ListenableFuture<Optional<DataObject>> read(final LogicalDatastoreType store,
+                final InstanceIdentifier<?> path) {
+            return doRead(getDelegate(), store, path);
+        }
+    }
+}