X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-clustering-commons%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2Fprotobuff%2Fclient%2Fmessages%2FPayload.java;h=fc65743e7bb6c53a2b42623495b0675db5577139;hb=7ce039b3e55d153fc75bc88198c49536ab83befc;hp=502c338f2298ea34b443d0b0f1e8d3a4d36df721;hpb=cc0542591cd61d968af7083409730f24954feae1;p=controller.git diff --git a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/Payload.java b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/Payload.java index 502c338f22..fc65743e7b 100644 --- a/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/Payload.java +++ b/opendaylight/md-sal/sal-clustering-commons/src/main/java/org/opendaylight/controller/cluster/raft/protobuff/client/messages/Payload.java @@ -1,5 +1,5 @@ /* - * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved. + * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, @@ -8,79 +8,16 @@ package org.opendaylight.controller.cluster.raft.protobuff.client.messages; - -import com.google.protobuf.GeneratedMessage; -import org.opendaylight.controller.protobuff.messages.cluster.raft.AppendEntriesMessages; - -import java.util.Map; - /** * An instance of a Payload class is meant to be used as the Payload for * AppendEntries. - *

* + *

* When an actor which is derived from RaftActor attempts to persistData it * must pass an instance of the Payload class. Similarly when state needs to * be applied to the derived RaftActor it will be passed an instance of the * Payload class. - *

- * - * To define your own payload do the following, - *

    - *
  1. Create your own protocol buffer message which extends the AppendEntries Payload
  2. - *
  3. Extend this Payload class
  4. - *
  5. Implement encode
  6. - *
  7. Implement decode
  8. - *
- * - * Your own protocol buffer message can be create like so,
- *
- * {@code
- *
- * import "AppendEntriesMessages.proto";
- *
- * package org.opendaylight.controller.cluster.raft;
- *
- * option java_package = "org.opendaylight.controller.cluster.raft.protobuff.messages";
- * option java_outer_classname = "MockPayloadMessages";
- *
- * extend AppendEntries.ReplicatedLogEntry.Payload {
- *      optional string value = 2;
- * }
- * }
- * 
- * */ public abstract class Payload { - private String clientPayloadClassName; - - public String getClientPayloadClassName() { - return this.getClass().getName(); - } - - public void setClientPayloadClassName(String clientPayloadClassName) { - this.clientPayloadClassName = clientPayloadClassName; - } - - /** - * Encode the payload data as a protocol buffer extension. - *

- * TODO: Add more meat in here - * @param - * @return Map of - */ - public abstract Map encode(); - - /** - * Decode the protocol buffer payload into a specific Payload as defined - * by the class extending RaftActor - * - * @param payload The payload in protocol buffer format - * @return - */ - public abstract Payload decode( - AppendEntriesMessages.AppendEntries.ReplicatedLogEntry.Payload payload); - - - + public abstract int size(); }