opendaylight/md-sal/sal-distributed-datastore/src/main/java/org/opendaylight/controller/cluster/datastore/persisted/PurgeTransactionPayload.java

   1 /*
   2  * Copyright (c) 2016 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.cluster.datastore.persisted;
   9
  10 import com.google.common.io.ByteArrayDataOutput;
  11 import com.google.common.io.ByteStreams;
  12 import java.io.DataInput;
  13 import java.io.IOException;
  14 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  15 import org.slf4j.Logger;
  16 import org.slf4j.LoggerFactory;
  17
  18 /**
  19  * Payload persisted when a transaction is purged from the frontend. It contains the transaction identifier.
  20  *
  21  * @author Robert Varga
  22  */
  23 public final class PurgeTransactionPayload extends AbstractIdentifiablePayload<TransactionIdentifier> {
  24     private static final class Proxy extends AbstractProxy<TransactionIdentifier> {
  25         private static final long serialVersionUID = 1L;
  26
  27         // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't
  28         // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection.
  29         @SuppressWarnings("checkstyle:RedundantModifier")
  30         public Proxy() {
  31             // For Externalizable
  32         }
  33
  34         Proxy(final byte[] serialized) {
  35             super(serialized);
  36         }
  37
  38         @Override
  39         protected TransactionIdentifier readIdentifier(final DataInput in) throws IOException {
  40             return TransactionIdentifier.readFrom(in);
  41         }
  42
  43         @Override
  44         protected PurgeTransactionPayload createObject(final TransactionIdentifier identifier,
  45                 final byte[] serialized) {
  46             return new PurgeTransactionPayload(identifier, serialized);
  47         }
  48     }
  49
  50     private static final Logger LOG = LoggerFactory.getLogger(PurgeTransactionPayload.class);
  51     private static final long serialVersionUID = 1L;
  52
  53     PurgeTransactionPayload(final TransactionIdentifier transactionId, final byte[] serialized) {
  54         super(transactionId, serialized);
  55     }
  56
  57     public static PurgeTransactionPayload create(final TransactionIdentifier transactionId) {
  58         final ByteArrayDataOutput out = ByteStreams.newDataOutput();
  59         try {
  60             transactionId.writeTo(out);
  61         } catch (IOException e) {
  62             // This should never happen
  63             LOG.error("Failed to serialize {}", transactionId, e);
  64             throw new RuntimeException("Failed to serialize " + transactionId, e);
  65         }
  66         return new PurgeTransactionPayload(transactionId, out.toByteArray());
  67     }
  68
  69     @Override
  70     protected Proxy externalizableProxy(final byte[] serialized) {
  71         return new Proxy(serialized);
  72     }
  73 }