Bug 1392: Change ReadTransaction#read to return CheckedFuture
[controller.git] / opendaylight / md-sal / sal-binding-broker / src / main / java / org / opendaylight / controller / md / sal / binding / impl / AbstractForwardedTransaction.java
1 /*
2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.controller.md.sal.binding.impl;
9
10 import org.opendaylight.controller.md.sal.common.api.data.AsyncTransaction;
11 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
12 import org.opendaylight.controller.md.sal.common.api.data.ReadFailedException;
13 import org.opendaylight.controller.md.sal.dom.api.DOMDataReadTransaction;
14 import org.opendaylight.yangtools.concepts.Delegator;
15 import org.opendaylight.yangtools.concepts.Identifiable;
16 import org.opendaylight.yangtools.util.concurrent.MappingCheckedFuture;
17 import org.opendaylight.yangtools.yang.binding.DataObject;
18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
20
21 import com.google.common.base.Optional;
22 import com.google.common.base.Preconditions;
23 import com.google.common.util.concurrent.CheckedFuture;
24 import com.google.common.util.concurrent.Futures;
25
26
27 abstract class AbstractForwardedTransaction<T extends AsyncTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>>>
28         implements Delegator<T>, Identifiable<Object> {
29
30     private final T delegate;
31     private final BindingToNormalizedNodeCodec codec;
32
33     public AbstractForwardedTransaction(final T delegateTx, final BindingToNormalizedNodeCodec codec) {
34         this.delegate = Preconditions.checkNotNull(delegateTx, "Delegate must not be null");
35         this.codec = Preconditions.checkNotNull(codec, "Codec must not be null");
36     }
37
38
39     @Override
40     public final  Object getIdentifier() {
41         return delegate.getIdentifier();
42     }
43
44     @Override
45     public final  T getDelegate() {
46         return delegate;
47     }
48
49     @SuppressWarnings("unchecked")
50     protected final <S extends AsyncTransaction<YangInstanceIdentifier, NormalizedNode<?, ?>>> S getDelegateChecked(final Class<S> txType) {
51         Preconditions.checkState(txType.isInstance(delegate));
52         return (S) delegate;
53     }
54
55     protected final BindingToNormalizedNodeCodec getCodec() {
56         return codec;
57     }
58
59     protected final <T extends DataObject> CheckedFuture<Optional<T>,ReadFailedException> doRead(
60             final DOMDataReadTransaction readTx, final LogicalDatastoreType store,
61             final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<T> path) {
62
63         return MappingCheckedFuture.create(
64                     Futures.transform(readTx.read(store, codec.toNormalized(path)),
65                                       codec.deserializeFunction(path)),
66                     ReadFailedException.MAPPER);
67     }
68 }