opendaylight/md-sal/mdsal-trace/dom-impl/src/main/java/org/opendaylight/controller/md/sal/trace/dom/impl/AbstractTracingWriteTransaction.java

   1 /*
   2  * Copyright (c) 2016 Red Hat, 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.trace.dom.impl;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import com.google.common.util.concurrent.FluentFuture;
  13 import java.util.ArrayList;
  14 import java.util.List;
  15 import java.util.Objects;
  16 import java.util.Set;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.common.api.data.TransactionCommitFailedException;
  19 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  20 import org.opendaylight.mdsal.common.api.CommitInfo;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  23
  24 abstract class AbstractTracingWriteTransaction implements DOMDataWriteTransaction {
  25
  26     private final DOMDataWriteTransaction delegate;
  27     private final TracingBroker tracingBroker;
  28     private final List<String> logs = new ArrayList<>();
  29
  30     AbstractTracingWriteTransaction(DOMDataWriteTransaction delegate, TracingBroker tracingBroker) {
  31         this.delegate = Objects.requireNonNull(delegate);
  32         this.tracingBroker = Objects.requireNonNull(tracingBroker);
  33     }
  34
  35     private void recordOp(LogicalDatastoreType store, YangInstanceIdentifier yiid, String method,
  36             NormalizedNode<?, ?> node) {
  37         if (!tracingBroker.isWriteWatched(yiid, store)) {
  38             return;
  39         }
  40
  41         final Object value = node != null ? node.getValue() : null;
  42
  43         if (value != null && value instanceof ImmutableSet && ((Set<?>)value).isEmpty()) {
  44             if (TracingBroker.LOG.isDebugEnabled()) {
  45                 TracingBroker.LOG.debug("Empty data set write to {}", tracingBroker.toPathString(yiid));
  46             }
  47         } else {
  48             StringBuilder sb = new StringBuilder();
  49             sb.append("Method \"").append(method);
  50             sb.append("\" to ").append(store);
  51             sb.append(" at ").append(tracingBroker.toPathString(yiid)).append('.');
  52             sb.append(" Data: ");
  53             if (node != null) {
  54                 sb.append(node.getValue());
  55             } else {
  56                 sb.append("null");
  57             }
  58             sb.append(" Stack:").append(tracingBroker.getStackSummary());
  59             synchronized (this) {
  60                 logs.add(sb.toString());
  61             }
  62         }
  63     }
  64
  65     private synchronized void logOps() {
  66         synchronized (this) {
  67             logs.forEach(log -> TracingBroker.LOG.warn(log));
  68             logs.clear();
  69         }
  70     }
  71
  72     @Override
  73     public void put(LogicalDatastoreType store, YangInstanceIdentifier yiid, NormalizedNode<?, ?> node) {
  74         recordOp(store, yiid, "put", node);
  75         delegate.put(store, yiid, node);
  76     }
  77
  78     @Override
  79     public void merge(LogicalDatastoreType store, YangInstanceIdentifier yiid, NormalizedNode<?, ?> node) {
  80         recordOp(store, yiid, "merge", node);
  81         delegate.merge(store, yiid, node);
  82     }
  83
  84     @Override
  85     public boolean cancel() {
  86         synchronized (this) {
  87             logs.clear();
  88         }
  89         boolean result = delegate.cancel();
  90         return result;
  91     }
  92
  93     @Override
  94     public void delete(LogicalDatastoreType store, YangInstanceIdentifier yiid) {
  95         recordOp(store, yiid, "delete", null);
  96         delegate.delete(store, yiid);
  97     }
  98
  99     @Override
 100     public CheckedFuture<Void, TransactionCommitFailedException> submit() {
 101         logOps();
 102         return delegate.submit();
 103     }
 104
 105     @Override
 106     public FluentFuture<? extends CommitInfo> commit() {
 107         logOps();
 108         return delegate.commit();
 109     }
 110
 111     @Override
 112     public Object getIdentifier() {
 113         return delegate.getIdentifier();
 114     }
 115
 116     // https://jira.opendaylight.org/browse/CONTROLLER-1792
 117
 118     @Override
 119     public final boolean equals(Object object) {
 120         return object == this || delegate.equals(object);
 121     }
 122
 123     @Override
 124     public final int hashCode() {
 125         return delegate.hashCode();
 126     }
 127
 128     @Override
 129     public final String toString() {
 130         return getClass().getName() + "; delegate=" + delegate;
 131     }
 132 }