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