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.FluentFuture;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.Objects;
  15 import java.util.Set;
  16 import javax.annotation.Nonnull;
  17 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  18 import org.opendaylight.controller.md.sal.dom.api.DOMDataWriteTransaction;
  19 import org.opendaylight.mdsal.common.api.CommitInfo;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  22
  23 abstract class AbstractTracingWriteTransaction implements DOMDataWriteTransaction {
  24
  25     private final DOMDataWriteTransaction delegate;
  26     private final TracingBroker tracingBroker;
  27     private final List<String> logs = new ArrayList<>();
  28
  29     AbstractTracingWriteTransaction(DOMDataWriteTransaction delegate, TracingBroker tracingBroker) {
  30         this.delegate = Objects.requireNonNull(delegate);
  31         this.tracingBroker = Objects.requireNonNull(tracingBroker);
  32         recordOp(null, null, "instantiate", null);
  33     }
  34
  35     private void recordOp(LogicalDatastoreType store, YangInstanceIdentifier yiid, String method,
  36             NormalizedNode<?, ?> node) {
  37         if (yiid != null && !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).append('"');
  50             if (store != null) {
  51                 sb.append(" to ").append(store);
  52             }
  53             if (yiid != null) {
  54                 sb.append(" at ").append(tracingBroker.toPathString(yiid));
  55             }
  56             sb.append('.');
  57             if (yiid != null) {
  58                 // If we don’t have an id, we don’t expect data either
  59                 sb.append(" Data: ");
  60                 if (node != null) {
  61                     sb.append(node.getValue());
  62                 } else {
  63                     sb.append("null");
  64                 }
  65             }
  66             sb.append(" Stack:").append(tracingBroker.getStackSummary());
  67             synchronized (this) {
  68                 logs.add(sb.toString());
  69             }
  70         }
  71     }
  72
  73     private synchronized void logOps() {
  74         synchronized (this) {
  75             if (TracingBroker.LOG.isWarnEnabled()) {
  76                 TracingBroker.LOG.warn("Transaction {} contains the following operations:", getIdentifier());
  77                 logs.forEach(TracingBroker.LOG::warn);
  78             }
  79             logs.clear();
  80         }
  81     }
  82
  83     @Override
  84     public void put(LogicalDatastoreType store, YangInstanceIdentifier yiid, NormalizedNode<?, ?> node) {
  85         recordOp(store, yiid, "put", node);
  86         delegate.put(store, yiid, node);
  87     }
  88
  89     @Override
  90     public void merge(LogicalDatastoreType store, YangInstanceIdentifier yiid, NormalizedNode<?, ?> node) {
  91         recordOp(store, yiid, "merge", node);
  92         delegate.merge(store, yiid, node);
  93     }
  94
  95     @Override
  96     public boolean cancel() {
  97         synchronized (this) {
  98             logs.clear();
  99         }
 100         return delegate.cancel();
 101     }
 102
 103     @Override
 104     public void delete(LogicalDatastoreType store, YangInstanceIdentifier yiid) {
 105         recordOp(store, yiid, "delete", null);
 106         delegate.delete(store, yiid);
 107     }
 108
 109     @Override
 110     public FluentFuture<? extends CommitInfo> commit() {
 111         recordOp(null, null, "commit", null);
 112         logOps();
 113         return delegate.commit();
 114     }
 115
 116     @Override
 117     @Nonnull
 118     public Object getIdentifier() {
 119         return delegate.getIdentifier();
 120     }
 121
 122     // https://jira.opendaylight.org/browse/CONTROLLER-1792
 123
 124     @Override
 125     public final boolean equals(Object object) {
 126         return object == this || delegate.equals(object);
 127     }
 128
 129     @Override
 130     public final int hashCode() {
 131         return delegate.hashCode();
 132     }
 133
 134     @Override
 135     public final String toString() {
 136         return getClass().getName() + "; delegate=" + delegate;
 137     }
 138 }