opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/CompositeModificationByteStringPayload.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
   9 package org.opendaylight.controller.cluster.raft.protobuff.client.messages;
  10
  11 import com.google.common.annotations.VisibleForTesting;
  12 import com.google.common.base.Preconditions;
  13 import com.google.protobuf.ByteString;
  14 import com.google.protobuf.GeneratedMessage;
  15 import com.google.protobuf.InvalidProtocolBufferException;
  16 import com.google.protobuf.UnknownFieldSet;
  17 import java.io.IOException;
  18 import java.io.Serializable;
  19 import java.lang.ref.SoftReference;
  20 import java.util.HashMap;
  21 import java.util.Map;
  22 import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages;
  23 import org.opendaylight.controller.protobuff.messages.persistent.PersistentMessages;
  24 import org.slf4j.Logger;
  25 import org.slf4j.LoggerFactory;
  26
  27 @Deprecated
  28 public class CompositeModificationByteStringPayload extends Payload implements
  29         Serializable {
  30     private static final long serialVersionUID = 1L;
  31
  32     private ByteString byteString;
  33     private SoftReference<PersistentMessages.CompositeModification> modificationReference;
  34     private static final Logger LOG = LoggerFactory.getLogger(CompositeModificationByteStringPayload.class);
  35
  36     public CompositeModificationByteStringPayload(){
  37         byteString = null;
  38     }
  39     public CompositeModificationByteStringPayload(Object modification){
  40         this(((PersistentMessages.CompositeModification) modification).toByteString());
  41         this.modificationReference = new SoftReference<>((PersistentMessages.CompositeModification) modification);
  42     }
  43
  44     private CompositeModificationByteStringPayload(ByteString byteString){
  45         this.byteString = Preconditions.checkNotNull(byteString, "byteString should not be null");
  46     }
  47
  48
  49     @Override
  50     public Map<GeneratedMessage.GeneratedExtension, PersistentMessages.CompositeModification> encode() {
  51         Preconditions.checkState(byteString!=null);
  52         Map<GeneratedMessage.GeneratedExtension, PersistentMessages.CompositeModification> map = new HashMap<>();
  53         map.put(org.opendaylight.controller.protobuff.messages.shard.CompositeModificationPayload.modification,
  54                 getModificationInternal());
  55         return map;
  56     }
  57
  58     @Override
  59     public Payload decode(
  60             AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payload) {
  61         PersistentMessages.CompositeModification modification = payload
  62                 .getExtension(
  63                         org.opendaylight.controller.protobuff.messages.shard.CompositeModificationPayload.modification);
  64
  65         // The extension was put in the unknown field.
  66         // This is because extensions need to be registered
  67         // see org.opendaylight.controller.mdsal.CompositeModificationPayload.registerAllExtensions
  68         // also see https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ExtensionRegistry
  69         // If that is not done then on the other end the extension shows up as an unknown field
  70         // Need to figure out a better way to do this
  71         if(payload.getUnknownFields().hasField(2)){
  72             UnknownFieldSet.Field field =
  73                     payload.getUnknownFields().getField(2);
  74
  75             return new CompositeModificationByteStringPayload(field.getLengthDelimitedList().get(0));
  76         }
  77
  78         return new CompositeModificationByteStringPayload(modification);
  79     }
  80
  81     public Object getModification(){
  82         return getModificationInternal();
  83     }
  84
  85     private PersistentMessages.CompositeModification getModificationInternal(){
  86         if(this.modificationReference != null && this.modificationReference.get() != null){
  87             return this.modificationReference.get();
  88         }
  89         try {
  90             PersistentMessages.CompositeModification compositeModification = PersistentMessages.CompositeModification.parseFrom(this.byteString);
  91             this.modificationReference = new SoftReference<>(compositeModification);
  92             return compositeModification;
  93         } catch (InvalidProtocolBufferException e) {
  94             LOG.error("Unexpected exception occurred when parsing byteString to CompositeModification", e);
  95         }
  96
  97         return null;
  98     }
  99
 100     @Override
 101     public int size(){
 102         return byteString.size();
 103     }
 104
 105     private void writeObject(java.io.ObjectOutputStream stream)
 106             throws IOException {
 107         byteString.writeTo(stream);
 108     }
 109
 110     private void readObject(java.io.ObjectInputStream stream)
 111             throws IOException, ClassNotFoundException {
 112         byteString = ByteString.readFrom(stream);
 113     }
 114
 115     @VisibleForTesting
 116     public void clearModificationReference(){
 117         if(this.modificationReference != null) {
 118             this.modificationReference.clear();
 119         }
 120     }
 121 }