introduce TransportResponse

a class that needs to be used when sending a response over the transport layer, with an option to have headers

Author: kimchy

src/main/java/org/elasticsearch/action/ActionResponse.java

@@ -19,10 +19,24 @@
 
 package org.elasticsearch.action;
 
-import org.elasticsearch.common.io.stream.Streamable;
+import org.elasticsearch.common.io.stream.StreamInput;
+import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.transport.TransportResponse;
+
+import java.io.IOException;
 
 /**
  *
  */
-public interface ActionResponse extends Streamable {
+public abstract class ActionResponse extends TransportResponse {
+
+    @Override
+    public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
+    }
+
+    @Override
+    public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
+    }
 }

src/main/java/org/elasticsearch/action/admin/cluster/health/ClusterHealthResponse.java

@@ -36,30 +36,19 @@
 /**
  *
  */
-public class ClusterHealthResponse implements ActionResponse, Iterable<ClusterIndexHealth> {
+public class ClusterHealthResponse extends ActionResponse implements Iterable<ClusterIndexHealth> {
 
     private String clusterName;
-
     int numberOfNodes = 0;
-
     int numberOfDataNodes = 0;
-
     int activeShards = 0;
-
     int relocatingShards = 0;
-
     int activePrimaryShards = 0;
-
     int initializingShards = 0;
-
     int unassignedShards = 0;
-
     boolean timedOut = false;
-
     ClusterHealthStatus status = ClusterHealthStatus.RED;
-
     private List<String> validationFailures;
-
     Map<String, ClusterIndexHealth> indices = Maps.newHashMap();
 
     ClusterHealthResponse() {
@@ -201,7 +190,8 @@ public Iterator<ClusterIndexHealth> iterator() {
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
-        clusterName = in.readUTF();
+        super.readFrom(in);
+        clusterName = in.readString();
         activePrimaryShards = in.readVInt();
         activeShards = in.readVInt();
         relocatingShards = in.readVInt();
@@ -221,14 +211,15 @@ public void readFrom(StreamInput in) throws IOException {
             validationFailures = ImmutableList.of();
         } else {
             for (int i = 0; i < size; i++) {
-                validationFailures.add(in.readUTF());
+                validationFailures.add(in.readString());
             }
         }
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
-        out.writeUTF(clusterName);
+        super.writeTo(out);
+        out.writeString(clusterName);
         out.writeVInt(activePrimaryShards);
         out.writeVInt(activeShards);
         out.writeVInt(relocatingShards);

src/main/java/org/elasticsearch/action/admin/cluster/node/shutdown/NodesShutdownResponse.java

@@ -30,10 +30,9 @@
 /**
  *
  */
-public class NodesShutdownResponse implements ActionResponse {
+public class NodesShutdownResponse extends ActionResponse {
 
     private ClusterName clusterName;
-
     private DiscoveryNode[] nodes;
 
     NodesShutdownResponse() {
@@ -62,6 +61,7 @@ public DiscoveryNode[] getNodes() {
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
         clusterName = ClusterName.readClusterName(in);
         nodes = new DiscoveryNode[in.readVInt()];
         for (int i = 0; i < nodes.length; i++) {
@@ -71,6 +71,7 @@ public void readFrom(StreamInput in) throws IOException {
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
         clusterName.writeTo(out);
         out.writeVInt(nodes.length);
         for (DiscoveryNode node : nodes) {

src/main/java/org/elasticsearch/action/admin/cluster/node/shutdown/TransportNodesShutdownAction.java

@@ -30,7 +30,6 @@
 import org.elasticsearch.common.inject.Inject;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.common.io.stream.VoidStreamable;
 import org.elasticsearch.common.settings.Settings;
 import org.elasticsearch.common.unit.TimeValue;
 import org.elasticsearch.node.Node;
@@ -47,11 +46,8 @@
 public class TransportNodesShutdownAction extends TransportMasterNodeOperationAction<NodesShutdownRequest, NodesShutdownResponse> {
 
     private final Node node;
-
     private final ClusterName clusterName;
-
     private final boolean disabled;
-
     private final TimeValue delay;
 
     @Inject
@@ -128,9 +124,9 @@ public void run() {
                             latch.countDown();
                         } else {
                             logger.trace("[cluster_shutdown]: sending shutdown request to [{}]", node);
-                            transportService.sendRequest(node, NodeShutdownRequestHandler.ACTION, new NodeShutdownRequest(request), new VoidTransportResponseHandler(ThreadPool.Names.SAME) {
+                            transportService.sendRequest(node, NodeShutdownRequestHandler.ACTION, new NodeShutdownRequest(request), new EmptyTransportResponseHandler(ThreadPool.Names.SAME) {
                                 @Override
-                                public void handleResponse(VoidStreamable response) {
+                                public void handleResponse(TransportResponse.Empty response) {
                                     logger.trace("[cluster_shutdown]: received shutdown response from [{}]", node);
                                     latch.countDown();
                                 }
@@ -152,9 +148,9 @@ public void handleException(TransportException exp) {
 
                     // now, kill the master
                     logger.trace("[cluster_shutdown]: shutting down the master [{}]", state.nodes().masterNode());
-                    transportService.sendRequest(state.nodes().masterNode(), NodeShutdownRequestHandler.ACTION, new NodeShutdownRequest(request), new VoidTransportResponseHandler(ThreadPool.Names.SAME) {
+                    transportService.sendRequest(state.nodes().masterNode(), NodeShutdownRequestHandler.ACTION, new NodeShutdownRequest(request), new EmptyTransportResponseHandler(ThreadPool.Names.SAME) {
                         @Override
-                        public void handleResponse(VoidStreamable response) {
+                        public void handleResponse(TransportResponse.Empty response) {
                             logger.trace("[cluster_shutdown]: received shutdown response from master");
                         }
 
@@ -196,9 +192,9 @@ public void run() {
                         }
 
                         logger.trace("[partial_cluster_shutdown]: sending shutdown request to [{}]", node);
-                        transportService.sendRequest(node, NodeShutdownRequestHandler.ACTION, new NodeShutdownRequest(request), new VoidTransportResponseHandler(ThreadPool.Names.SAME) {
+                        transportService.sendRequest(node, NodeShutdownRequestHandler.ACTION, new NodeShutdownRequest(request), new EmptyTransportResponseHandler(ThreadPool.Names.SAME) {
                             @Override
-                            public void handleResponse(VoidStreamable response) {
+                            public void handleResponse(TransportResponse.Empty response) {
                                 logger.trace("[partial_cluster_shutdown]: received shutdown response from [{}]", node);
                                 latch.countDown();
                             }
@@ -288,7 +284,7 @@ public void run() {
             });
             t.start();
 
-            channel.sendResponse(VoidStreamable.INSTANCE);
+            channel.sendResponse(TransportResponse.Empty.INSTANCE);
         }
     }
 

src/main/java/org/elasticsearch/action/admin/cluster/reroute/ClusterRerouteResponse.java

@@ -28,7 +28,7 @@
 
 /**
  */
-public class ClusterRerouteResponse implements ActionResponse {
+public class ClusterRerouteResponse extends ActionResponse {
 
     private ClusterState state;
 
@@ -50,11 +50,13 @@ public ClusterState getState() {
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
         state = ClusterState.Builder.readFrom(in, null);
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
         ClusterState.Builder.writeTo(state, out);
     }
 }

src/main/java/org/elasticsearch/action/admin/cluster/settings/ClusterUpdateSettingsResponse.java

@@ -22,23 +22,24 @@
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.common.io.stream.Streamable;
 
 import java.io.IOException;
 
 /**
  * A response for a cluster update settings action.
  */
-public class ClusterUpdateSettingsResponse implements ActionResponse, Streamable {
+public class ClusterUpdateSettingsResponse extends ActionResponse {
 
     ClusterUpdateSettingsResponse() {
     }
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
     }
 }

src/main/java/org/elasticsearch/action/admin/cluster/state/ClusterStateResponse.java

@@ -30,10 +30,9 @@
 /**
  *
  */
-public class ClusterStateResponse implements ActionResponse {
+public class ClusterStateResponse extends ActionResponse {
 
     private ClusterName clusterName;
-
     private ClusterState clusterState;
 
     public ClusterStateResponse() {
@@ -62,12 +61,14 @@ public ClusterName getClusterName() {
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
         clusterName = ClusterName.readClusterName(in);
         clusterState = ClusterState.Builder.readFrom(in, null);
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
         clusterName.writeTo(out);
         ClusterState.Builder.writeTo(clusterState, out);
     }

src/main/java/org/elasticsearch/action/admin/indices/alias/IndicesAliasesResponse.java

@@ -22,16 +22,13 @@
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.common.io.stream.Streamable;
 
 import java.io.IOException;
 
 /**
  * A response for a add/remove alias action.
- *
- *
  */
-public class IndicesAliasesResponse implements ActionResponse, Streamable {
+public class IndicesAliasesResponse extends ActionResponse {
 
     private boolean acknowledged;
 
@@ -54,11 +51,13 @@ public boolean getAcknowledged() {
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
         acknowledged = in.readBoolean();
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
         out.writeBoolean(acknowledged);
     }
 }

src/main/java/org/elasticsearch/action/admin/indices/analyze/AnalyzeResponse.java

@@ -34,7 +34,7 @@
 /**
  *
  */
-public class AnalyzeResponse implements ActionResponse, Iterable<AnalyzeResponse.AnalyzeToken>, ToXContent {
+public class AnalyzeResponse extends ActionResponse implements Iterable<AnalyzeResponse.AnalyzeToken>, ToXContent {
 
     public static class AnalyzeToken implements Streamable {
         private String term;
@@ -102,27 +102,20 @@ public static AnalyzeToken readAnalyzeToken(StreamInput in) throws IOException {
 
         @Override
         public void readFrom(StreamInput in) throws IOException {
-            term = in.readUTF();
+            term = in.readString();
             startOffset = in.readInt();
             endOffset = in.readInt();
             position = in.readVInt();
-            if (in.readBoolean()) {
-                type = in.readUTF();
-            }
+            type = in.readOptionalString();
         }
 
         @Override
         public void writeTo(StreamOutput out) throws IOException {
-            out.writeUTF(term);
+            out.writeString(term);
             out.writeInt(startOffset);
             out.writeInt(endOffset);
             out.writeVInt(position);
-            if (type == null) {
-                out.writeBoolean(false);
-            } else {
-                out.writeBoolean(true);
-                out.writeUTF(type);
-            }
+            out.writeOptionalString(type);
         }
     }
 
@@ -186,6 +179,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
         int size = in.readVInt();
         tokens = new ArrayList<AnalyzeToken>(size);
         for (int i = 0; i < size; i++) {
@@ -195,6 +189,7 @@ public void readFrom(StreamInput in) throws IOException {
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
         out.writeVInt(tokens.size());
         for (AnalyzeToken token : tokens) {
             token.writeTo(out);

src/main/java/org/elasticsearch/action/admin/indices/close/CloseIndexResponse.java

@@ -22,16 +22,13 @@
 import org.elasticsearch.action.ActionResponse;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
-import org.elasticsearch.common.io.stream.Streamable;
 
 import java.io.IOException;
 
 /**
  * A response for a close index action.
- *
- *
  */
-public class CloseIndexResponse implements ActionResponse, Streamable {
+public class CloseIndexResponse extends ActionResponse {
 
     private boolean acknowledged;
 
@@ -52,11 +49,13 @@ public boolean getAcknowledged() {
 
     @Override
     public void readFrom(StreamInput in) throws IOException {
+        super.readFrom(in);
         acknowledged = in.readBoolean();
     }
 
     @Override
     public void writeTo(StreamOutput out) throws IOException {
+        super.writeTo(out);
         out.writeBoolean(acknowledged);
     }
 }