/* * Copyright (c) 2014, 2017 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.remote.rpc.messages; import com.google.common.base.MoreObjects; import com.google.common.base.Preconditions; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import java.io.Externalizable; import java.io.IOException; import java.io.ObjectInput; import java.io.ObjectOutput; import java.io.Serializable; import javax.annotation.Nonnull; import javax.annotation.Nullable; import org.opendaylight.controller.cluster.datastore.node.utils.stream.SerializationUtils; import org.opendaylight.controller.md.sal.dom.api.DOMRpcIdentifier; import org.opendaylight.yangtools.yang.common.QName; import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode; public final class ExecuteRpc implements Serializable { private static final long serialVersionUID = 1128904894827335676L; @SuppressFBWarnings(value = "SE_BAD_FIELD", justification = "This field is not Serializable but this class " + "implements writeReplace to delegate serialization to a Proxy class and thus instances of this class " + "aren't serialized. FindBugs does not recognize this.") private final NormalizedNode inputNormalizedNode; private final QName rpc; private ExecuteRpc(@Nullable final NormalizedNode inputNormalizedNode, @Nonnull final QName rpc) { this.rpc = Preconditions.checkNotNull(rpc, "rpc Qname should not be null"); this.inputNormalizedNode = inputNormalizedNode; } public static ExecuteRpc from(@Nonnull final DOMRpcIdentifier rpc, @Nullable final NormalizedNode input) { return new ExecuteRpc(input, rpc.getType().getLastComponent()); } @Nullable public NormalizedNode getInputNormalizedNode() { return inputNormalizedNode; } @Nonnull public QName getRpc() { return rpc; } private Object writeReplace() { return new Proxy(this); } @Override public String toString() { return MoreObjects.toStringHelper(this) .add("rpc", rpc) .add("normalizedNode", inputNormalizedNode) .toString(); } private static class Proxy implements Externalizable { private static final long serialVersionUID = 1L; private ExecuteRpc executeRpc; // checkstyle flags the public modifier as redundant which really doesn't make sense since it clearly isn't // redundant. It is explicitly needed for Java serialization to be able to create instances via reflection. @SuppressWarnings("checkstyle:RedundantModifier") public Proxy() { } Proxy(ExecuteRpc executeRpc) { this.executeRpc = executeRpc; } @Override public void writeExternal(ObjectOutput out) throws IOException { out.writeObject(executeRpc.getRpc()); SerializationUtils.serializeNormalizedNode(executeRpc.getInputNormalizedNode(), out); } @Override public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException { QName qname = (QName) in.readObject(); executeRpc = new ExecuteRpc(SerializationUtils.deserializeNormalizedNode(in), qname); } private Object readResolve() { return executeRpc; } } }