BUG-5280: add a transction purge step
[controller.git] / 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 com.google.common.annotations.Beta;
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  * @author Robert Varga
21  */
22 @Beta
23 public final class TransactionPurgeRequest extends TransactionRequest<TransactionPurgeRequest> {
24     private static final long serialVersionUID = 1L;
25
26     public TransactionPurgeRequest(final TransactionIdentifier target, final long sequence, final ActorRef replyTo) {
27         super(target, sequence, replyTo);
28     }
29
30     @Override
31     protected TransactionPurgeRequestProxyV1 externalizableProxy(final ABIVersion version) {
32         return new TransactionPurgeRequestProxyV1(this);
33     }
34
35     @Override
36     protected TransactionPurgeRequest cloneAsVersion(final ABIVersion version) {
37         return this;
38     }
39 }