/*
- * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
+ * 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,
*/
package org.opendaylight.controller.remote.rpc.messages;
+import static java.util.Objects.requireNonNull;
-import com.google.common.base.Preconditions;
+import com.google.common.base.MoreObjects;
+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 org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.controller.cluster.datastore.node.utils.stream.SerializationUtils;
+import org.opendaylight.mdsal.dom.api.DOMRpcIdentifier;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
-import java.io.Serializable;
+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(final @Nullable NormalizedNode<?, ?> inputNormalizedNode, final @NonNull QName rpc) {
+ this.rpc = requireNonNull(rpc, "rpc Qname should not be null");
+ this.inputNormalizedNode = inputNormalizedNode;
+ }
+
+ public static ExecuteRpc from(final @NonNull DOMRpcIdentifier rpc, final @Nullable NormalizedNode<?, ?> input) {
+ return new ExecuteRpc(input, rpc.getType().getLastComponent());
+ }
+
+ public @Nullable NormalizedNode<?, ?> getInputNormalizedNode() {
+ return inputNormalizedNode;
+ }
+
+ public @NonNull 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;
-public class ExecuteRpc implements Serializable {
+ private ExecuteRpc executeRpc;
- private final String inputCompositeNode;
- private final QName rpc;
+ // 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() {
+ }
- public ExecuteRpc(final String inputCompositeNode, final QName rpc) {
- Preconditions.checkNotNull(inputCompositeNode, "Composite Node input string should be present");
- Preconditions.checkNotNull(rpc, "rpc Qname should not be null");
+ Proxy(ExecuteRpc executeRpc) {
+ this.executeRpc = executeRpc;
+ }
- this.inputCompositeNode = inputCompositeNode;
- this.rpc = rpc;
- }
+ @Override
+ public void writeExternal(ObjectOutput out) throws IOException {
+ out.writeObject(executeRpc.getRpc());
+ SerializationUtils.serializeNormalizedNode(executeRpc.getInputNormalizedNode(), out);
+ }
- public String getInputCompositeNode() {
- return inputCompositeNode;
- }
+ @Override
+ public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException {
+ QName qname = (QName) in.readObject();
+ executeRpc = new ExecuteRpc(SerializationUtils.deserializeNormalizedNode(in), qname);
+ }
- public QName getRpc() {
- return rpc;
- }
+ private Object readResolve() {
+ return executeRpc;
+ }
+ }
}