opendaylight/md-sal/cds-access-api/src/main/java/org/opendaylight/controller/cluster/access/commands/TransactionPurgeRequest.java

   1 /*
   2  * Copyright (c) 2017 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.access.commands;
   9
  10 import akka.actor.ActorRef;
  11 import java.io.ObjectInput;
  12 import org.opendaylight.controller.cluster.access.ABIVersion;
  13 import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
  14
  15 /**
  16  * A transaction request to perform the final transaction transition, which is purging it from the protocol view,
  17  * meaning the frontend has no further knowledge of the transaction. The backend is free to purge any state related
  18  * to the transaction and responds with a {@link TransactionPurgeResponse}.
  19  */
  20 public final class TransactionPurgeRequest extends TransactionRequest<TransactionPurgeRequest> {
  21     interface SerialForm extends TransactionRequest.SerialForm<TransactionPurgeRequest> {
  22         @Override
  23         default TransactionPurgeRequest readExternal(final ObjectInput in, final TransactionIdentifier target,
  24                 final long sequence, final ActorRef replyTo) {
  25             return new TransactionPurgeRequest(target, sequence, replyTo);
  26         }
  27     }
  28
  29     @java.io.Serial
  30     private static final long serialVersionUID = 1L;
  31
  32     private TransactionPurgeRequest(final TransactionPurgeRequest request, final ABIVersion version) {
  33         super(request, version);
  34     }
  35
  36     public TransactionPurgeRequest(final TransactionIdentifier target, final long sequence, final ActorRef replyTo) {
  37         super(target, sequence, replyTo);
  38     }
  39
  40     @Override
  41     protected SerialForm externalizableProxy(final ABIVersion version) {
  42         return new TPR(this);
  43     }
  44
  45     @Override
  46     protected TransactionPurgeRequest cloneAsVersion(final ABIVersion version) {
  47         return new TransactionPurgeRequest(this, version);
  48     }
  49 }