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