org.opendaylight.controller.cluster.access.commands.ModifyTransactionRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cds-access-api Show documentation
The newest version!
/*
 * Copyright (c) 2016 Cisco Systems, Inc. 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,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.controller.cluster.access.commands;

import akka.actor.ActorRef;
import com.google.common.base.MoreObjects.ToStringHelper;
import com.google.common.collect.ImmutableList;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectInputStream;
import java.io.ObjectOutput;
import java.io.ObjectOutputStream;
import java.io.ObjectStreamException;
import java.util.ArrayList;
import java.util.List;
import java.util.Optional;
import org.opendaylight.controller.cluster.access.ABIVersion;
import org.opendaylight.controller.cluster.access.concepts.SliceableMessage;
import org.opendaylight.controller.cluster.access.concepts.TransactionIdentifier;
import org.opendaylight.yangtools.yang.data.codec.binfmt.NormalizedNodeDataInput;
import org.opendaylight.yangtools.yang.data.impl.schema.ReusableImmutableNormalizedNodeStreamWriter;

/**
 * A transaction request to apply a particular set of operations on top of the current transaction. This message is
 * used to also finish a transaction by specifying a {@link PersistenceProtocol}.
 */
public final class ModifyTransactionRequest extends TransactionRequest
        implements SliceableMessage {
    interface SerialForm extends TransactionRequest.SerialForm {


        @Override
        default ModifyTransactionRequest readExternal(final ObjectInput in, final TransactionIdentifier target,
                final long sequence, final ActorRef replyTo) throws IOException {

            final var protocol = Optional.ofNullable(PersistenceProtocol.readFrom(in));
            final int size = in.readInt();
            final List modifications;
            if (size != 0) {
                modifications = new ArrayList<>(size);
                final var nnin = NormalizedNodeDataInput.newDataInput(in);
                final var writer = ReusableImmutableNormalizedNodeStreamWriter.create();
                for (int i = 0; i < size; ++i) {
                    modifications.add(TransactionModification.readFrom(nnin, writer));
                }
            } else {
                modifications = ImmutableList.of();
            }

            return new ModifyTransactionRequest(target, sequence, replyTo, modifications, protocol.orElse(null));
        }

        @Override
        default void writeExternal(final ObjectOutput out, final ModifyTransactionRequest msg) throws IOException {
            TransactionRequest.SerialForm.super.writeExternal(out, msg);

            out.writeByte(PersistenceProtocol.byteValue(msg.getPersistenceProtocol().orElse(null)));

            final var modifications = msg.getModifications();
            out.writeInt(modifications.size());
            if (!modifications.isEmpty()) {
                try (var nnout = msg.getVersion().getStreamVersion().newDataOutput(out)) {
                    for (var op : modifications) {
                        op.writeTo(nnout);
                    }
                }
            }
        }
    }

    @java.io.Serial
    private static final long serialVersionUID = 1L;

    private final List modifications;
    private final PersistenceProtocol protocol;

    private ModifyTransactionRequest(final ModifyTransactionRequest request, final ABIVersion version) {
        super(request, version);
        modifications = request.modifications;
        protocol = request.protocol;
    }

    ModifyTransactionRequest(final TransactionIdentifier target, final long sequence, final ActorRef replyTo,
        final List modifications, final PersistenceProtocol protocol) {
        super(target, sequence, replyTo);
        this.modifications = ImmutableList.copyOf(modifications);
        this.protocol = protocol;
    }

    public Optional getPersistenceProtocol() {
        return Optional.ofNullable(protocol);
    }

    public List getModifications() {
        return modifications;
    }

    @Override
    protected ToStringHelper addToStringAttributes(final ToStringHelper toStringHelper) {
        return super.addToStringAttributes(toStringHelper).add("modifications", modifications.size())
                .add("protocol", protocol);
    }

    @Override
    protected SerialForm externalizableProxy(final ABIVersion version) {
        return new MTR(this);
    }

    @Override
    protected ModifyTransactionRequest cloneAsVersion(final ABIVersion version) {
        return new ModifyTransactionRequest(this, version);
    }

    @java.io.Serial
    private void readObject(final ObjectInputStream stream) throws IOException, ClassNotFoundException {
        throwNSE();
    }

    @java.io.Serial
    private void readObjectNoData() throws ObjectStreamException {
        throwNSE();
    }

    @java.io.Serial
    private void writeObject(final ObjectOutputStream stream) throws IOException {
        throwNSE();
    }
}