Rename RequestType to RequestMethod

Method seems to be a more standard term than "Type".
We wanted to keep the term "Request" (rather than Http) since it is a parameter that is only valid for the request.

Author: jentfoo

client/src/main/java/org/threadly/litesockets/client/http/HTTPClient.java

@@ -36,7 +36,7 @@
 import org.threadly.litesockets.protocols.http.response.HTTPResponseProcessor.HTTPResponseCallback;
 import org.threadly.litesockets.protocols.http.shared.HTTPAddress;
 import org.threadly.litesockets.protocols.http.shared.HTTPParsingException;
-import org.threadly.litesockets.protocols.http.shared.HTTPRequestType;
+import org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod;
 import org.threadly.litesockets.protocols.http.shared.HTTPResponseCode;
 import org.threadly.litesockets.protocols.ws.WebSocketFrameParser.WebSocketFrame;
 import org.threadly.litesockets.utils.IOUtils;
@@ -173,7 +173,8 @@ public void closeAllClients() {
    * @param timeout time in milliseconds to wait for HTTPRequests to finish.
    */
   public void setTimeout(long timeout, TimeUnit unit) {
-    this.defaultTimeoutMS = Math.min(Math.max(unit.toMillis(timeout),HTTPRequest.MIN_TIMEOUT_MS), HTTPRequest.MAX_TIMEOUT_MS);
+    this.defaultTimeoutMS = Math.min(Math.max(unit.toMillis(timeout),HTTPRequest.MIN_TIMEOUT_MS), 
+                                     HTTPRequest.MAX_TIMEOUT_MS);
   }
 
   public long getMaxIdleTimeout() {
@@ -210,22 +211,22 @@ public void run() {
    * @throws HTTPParsingException is thrown if the server sends back protocol or a response that is larger then allowed.
    */
   public HTTPResponseData request(final URL url) throws HTTPParsingException {
-    return request(url, HTTPRequestType.GET, IOUtils.EMPTY_BYTEBUFFER);
+    return request(url, HTTPRequestMethod.GET, IOUtils.EMPTY_BYTEBUFFER);
   }
 
   /**
    * Sends a blocking HTTP request.
    * 
    * @param url the url to send the request too.
-   * @param rt the {@link HTTPRequestType} to use on the request.
+   * @param rm the {@link HTTPRequestMethod} to use on the request.
    * @param bb the data to put in the body for this request.
    * @return an {@link HTTPResponseData} object containing the headers and content of the response.
    * @throws HTTPParsingException is thrown if the server sends back protocol or a response that is larger then allowed.
    */
-  public HTTPResponseData request(final URL url, final HTTPRequestType rt, final ByteBuffer bb) throws HTTPParsingException {
+  public HTTPResponseData request(final URL url, final HTTPRequestMethod rm, final ByteBuffer bb) throws HTTPParsingException {
     HTTPResponseData hr = null;
     try {
-      hr = requestAsync(url, rt, bb).get();
+      hr = requestAsync(url, rm, bb).get();
     } catch (InterruptedException e) {
       Thread.currentThread().interrupt();
     } catch (Exception e) {
@@ -275,21 +276,22 @@ public HTTPResponseData request(final ClientHTTPRequest request) throws HTTPPars
    * successfully or with errors.
    */
   public ListenableFuture<HTTPResponseData> requestAsync(final URL url) {
-    return requestAsync(url, HTTPRequestType.GET, IOUtils.EMPTY_BYTEBUFFER);
+    return requestAsync(url, HTTPRequestMethod.GET, IOUtils.EMPTY_BYTEBUFFER);
   }
 
   /**
    * Sends an asynchronous HTTP request.
    * 
    * @param url the {@link URL} to send the request too.
-   * @param rt the {@link HTTPRequestType} to use on the request.
+   * @param rm the {@link HTTPRequestMethod} to use on the request.
    * @param bb the data to put in the body for this request.
    * @return an {@link ListenableFuture} containing a {@link HTTPResponseData} object that will be completed when the request is finished, 
    * successfully or with errors.
    */
-  public ListenableFuture<HTTPResponseData> requestAsync(final URL url, final HTTPRequestType rt, final ByteBuffer bb) {
+  public ListenableFuture<HTTPResponseData> requestAsync(final URL url, final HTTPRequestMethod rm, 
+                                                         final ByteBuffer bb) {
     HTTPRequestBuilder hrb = new HTTPRequestBuilder(url);
-    hrb.setRequestType(rt);
+    hrb.setRequestMethod(rm);
     hrb.setTimeout(this.defaultTimeoutMS, TimeUnit.MILLISECONDS);
     if (bb != null && bb.hasRemaining()) {
       hrb.setBody(bb);
@@ -508,7 +510,7 @@ private class HTTPRequestWrapper implements HTTPResponseCallback {
     public HTTPRequestWrapper(ClientHTTPRequest chr) {
       hrp = new HTTPResponseProcessor(chr.getHTTPRequest()
                                          .getHTTPRequestHeader()
-                                         .getRequestType().equals("HEAD"));
+                                         .getRequestMethod().equals("HEAD"));
       hrp.addHTTPResponseCallback(this);
       this.chr = chr;
     }
@@ -567,7 +569,8 @@ public static class HTTPResponseData {
     private final MergedByteBuffers body;
     private final HTTPClient client;
 
-    public HTTPResponseData(HTTPClient client, HTTPRequest origRequest, HTTPResponse hr, MergedByteBuffers bb) {
+    public HTTPResponseData(HTTPClient client, HTTPRequest origRequest, HTTPResponse hr, 
+                            MergedByteBuffers bb) {
       this.client = client;
       this.hr = hr;
       this.body = bb;

client/src/main/java/org/threadly/litesockets/client/ws/WebSocketClient.java

@@ -23,7 +23,7 @@
 import org.threadly.litesockets.protocols.http.response.HTTPResponse;
 import org.threadly.litesockets.protocols.http.response.HTTPResponseBuilder;
 import org.threadly.litesockets.protocols.http.shared.HTTPConstants;
-import org.threadly.litesockets.protocols.http.shared.HTTPRequestType;
+import org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod;
 import org.threadly.litesockets.protocols.http.shared.HTTPResponseCode;
 import org.threadly.litesockets.protocols.ws.WebSocketFrameParser;
 import org.threadly.litesockets.protocols.ws.WebSocketFrameParser.WebSocketFrame;
@@ -45,7 +45,7 @@ public class WebSocketClient implements StreamingClient {
       .setHeader(HTTPConstants.HTTP_KEY_WEBSOCKET_ACCEPT, "123456")
       .build();
   public static final HTTPRequest DEFAULT_WS_REQUEST = new HTTPRequestBuilder()
-      .setRequestType(HTTPRequestType.GET)
+      .setRequestMethod(HTTPRequestMethod.GET)
       .setHeader(HTTPConstants.HTTP_KEY_UPGRADE, "websocket")
       .setHeader(HTTPConstants.HTTP_KEY_CONNECTION, "Upgrade")
       .setHeader(HTTPConstants.HTTP_KEY_WEBSOCKET_VERSION, "13")

gradle.properties

@@ -1,5 +1,5 @@
 group = org.threadly
-version = 0.14
+version = 0.15
 threadlyVersion = 5.16
 litesocketsVersion = 4.3
 org.gradle.parallel=true

protocol/src/main/java/org/threadly/litesockets/protocols/http/request/HTTPRequestBuilder.java

@@ -12,7 +12,7 @@
 import org.threadly.litesockets.protocols.http.shared.HTTPAddress;
 import org.threadly.litesockets.protocols.http.shared.HTTPConstants;
 import org.threadly.litesockets.protocols.http.shared.HTTPHeaders;
-import org.threadly.litesockets.protocols.http.shared.HTTPRequestType;
+import org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod;
 import org.threadly.litesockets.protocols.http.shared.HTTPUtils;
 import org.threadly.util.ArgumentVerifier;
 
@@ -67,9 +67,9 @@ public HTTPRequestBuilder setURL(final URL url) {
     }
     String q = url.getQuery();
     if(q != null) {
-      request = new HTTPRequestHeader(request.getRequestType(), tmpPath, HTTPUtils.queryToMap(q), request.getHttpVersion());
+      request = new HTTPRequestHeader(request.getRequestMethod(), tmpPath, HTTPUtils.queryToMap(q), request.getHttpVersion());
     } else {
-      request = new HTTPRequestHeader(request.getRequestType(), tmpPath, null, request.getHttpVersion());
+      request = new HTTPRequestHeader(request.getRequestMethod(), tmpPath, null, request.getHttpVersion());
     }
     if(url.getProtocol().equalsIgnoreCase("https")) {
       doSSL = true;
@@ -91,13 +91,14 @@ public HTTPRequestBuilder setHTTPRequestHeader(final HTTPRequestHeader hrh) {
   }
 
   /**
-   * Sets the {@link HTTPRequestType} for this request.  This will accept non-stander strings in the for the request.
+   * Sets the {@link HTTPRequestMethod} for this request.  This will accept non-stander strings in the for the request.
    * 
-   * @param rt the RequestType to set this request too.
+   * @param rm the http request method to set this request too.
    * @return the current {@link HTTPRequestBuilder} object.
    */
-  public HTTPRequestBuilder setRequestType(final String rt) {
-    this.request = new HTTPRequestHeader(rt, request.getRequestPath(), request.getRequestQuery(), request.getHttpVersion());
+  public HTTPRequestBuilder setRequestMethod(final String rm) {
+    this.request = new HTTPRequestHeader(rm, request.getRequestPath(), request.getRequestQuery(), 
+                                         request.getHttpVersion());
     return this;
   }
 
@@ -108,7 +109,8 @@ public HTTPRequestBuilder setRequestType(final String rt) {
    * @return the current {@link HTTPRequestBuilder} object.
    */
   public HTTPRequestBuilder setHTTPVersion(final String version) {
-    this.request = new HTTPRequestHeader(request.getRequestType(), request.getRequestPath(), request.getRequestQuery(), version);
+    this.request = new HTTPRequestHeader(request.getRequestMethod(), request.getRequestPath(), 
+                                         request.getRequestQuery(), version);
     return this;
   }
 
@@ -122,9 +124,11 @@ public HTTPRequestBuilder setHTTPVersion(final String version) {
    */
   public HTTPRequestBuilder setPath(final String path) {
     if(path.contains("?")) {
-      this.request = new HTTPRequestHeader(request.getRequestType(), path, HTTPUtils.queryToMap(path), request.getHttpVersion());
+      this.request = new HTTPRequestHeader(request.getRequestMethod(), path, 
+                                           HTTPUtils.queryToMap(path), request.getHttpVersion());
     } else {
-      this.request = new HTTPRequestHeader(request.getRequestType(), path, request.getRequestQuery(), request.getHttpVersion());
+      this.request = new HTTPRequestHeader(request.getRequestMethod(), path, 
+                                           request.getRequestQuery(), request.getHttpVersion());
     }
     return this;
   }
@@ -136,7 +140,7 @@ public HTTPRequestBuilder setPath(final String path) {
    * @return the current {@link HTTPRequestBuilder} object.
    */
   public HTTPRequestBuilder setQueryString(final String query) {
-    this.request = new HTTPRequestHeader(request.getRequestType(), request.getRequestPath(), HTTPUtils.queryToMap(query), request.getHttpVersion());
+    this.request = new HTTPRequestHeader(request.getRequestMethod(), request.getRequestPath(), HTTPUtils.queryToMap(query), request.getHttpVersion());
     return this;
   }
 
@@ -150,7 +154,7 @@ public HTTPRequestBuilder setQueryString(final String query) {
   public HTTPRequestBuilder appendQuery(final String key, final String value) {
     HashMap<String, String> map = new HashMap<String, String>(request.getRequestQuery());
     map.put(key, value);
-    this.request = new HTTPRequestHeader(request.getRequestType(), request.getRequestPath(), map, request.getHttpVersion());
+    this.request = new HTTPRequestHeader(request.getRequestMethod(), request.getRequestPath(), map, request.getHttpVersion());
     return this;
   }
 
@@ -163,7 +167,7 @@ public HTTPRequestBuilder appendQuery(final String key, final String value) {
   public HTTPRequestBuilder removeQuery(final String key) {
     HashMap<String, String> map = new HashMap<String, String>(request.getRequestQuery());
     map.remove(key);
-    this.request = new HTTPRequestHeader(request.getRequestType(), request.getRequestPath(), map, request.getHttpVersion());
+    this.request = new HTTPRequestHeader(request.getRequestMethod(), request.getRequestPath(), map, request.getHttpVersion());
     return this;
   }
 
@@ -301,13 +305,14 @@ public HTTPRequestBuilder replaceHTTPHeaders(final HTTPHeaders hh) {
 
 
   /**
-   * Sets the {@link HTTPRequestType} for this request.  This uses the standard http request types enum.
+   * Sets the {@link HTTPRequestMethod} for this request.  This uses the standard http request methods enum.
    * 
-   * @param rt the RequestType to set this request too.
+   * @param rm the http request method to set this request too.
    * @return the current {@link HTTPRequestBuilder} object.
    */
-  public HTTPRequestBuilder setRequestType(final HTTPRequestType rt) {
-    this.request = new HTTPRequestHeader(rt, request.getRequestPath(), request.getRequestQuery(), request.getHttpVersion());
+  public HTTPRequestBuilder setRequestMethod(final HTTPRequestMethod rm) {
+    this.request = new HTTPRequestHeader(rm, request.getRequestPath(), request.getRequestQuery(), 
+                                         request.getHttpVersion());
     return this;
   }
 

protocol/src/main/java/org/threadly/litesockets/protocols/http/request/HTTPRequestHeader.java

@@ -6,18 +6,18 @@
 import java.util.Map;
 
 import org.threadly.litesockets.protocols.http.shared.HTTPConstants;
-import org.threadly.litesockets.protocols.http.shared.HTTPRequestType;
+import org.threadly.litesockets.protocols.http.shared.HTTPRequestMethod;
 import org.threadly.litesockets.protocols.http.shared.HTTPUtils;
 
 /**
  * This is an immutable HTTP Request Header.  Basically the first line of the http request.  
  * 
- * This is the first line of an http request formated with spaces "RequestType path?query version".
+ * This is the first line of an http request formated with spaces "RequestMethod path?query version".
  */
 public class HTTPRequestHeader {
   private static final int REQUIRED_REQUEST_ITEMS = 3;
   private final String rawRequest;
-  private final String requestType;
+  private final String requestMethod;
   private final String requestPath;
   private final Map<String, String> requestQuery;
   private final String httpVersion;
@@ -34,7 +34,7 @@ public HTTPRequestHeader(final String requestHeader) {
     if(tmp.length != REQUIRED_REQUEST_ITEMS) {
       throw new IllegalArgumentException("HTTPRequestHeader can only have 3 arguments! :"+requestHeader);
     }
-    requestType = tmp[0].trim().toUpperCase();
+    requestMethod = tmp[0].trim().toUpperCase();
     String ptmp = tmp[1].trim();
     int queryParamPos = ptmp.indexOf('?');
     if(queryParamPos >= 0) {
@@ -54,25 +54,28 @@ public HTTPRequestHeader(final String requestHeader) {
   /**
    * Creates a new Immutable {@link HTTPRequest} object from the parts that are in a request.
    * 
-   * @param requestType the {@link HTTPRequestType} to set.
-   * @param requestPath the {@link HTTPRequestType} to set.
+   * @param requestMethod the {@link HTTPRequestMethod} to set.
+   * @param requestPath the {@link HTTPRequestMethod} to set.
    * @param requestQuery the query to set.
    * @param httpVersion the httpVersion to set.
    */
-  public HTTPRequestHeader(HTTPRequestType requestType, String requestPath, Map<String, String> requestQuery, String httpVersion){
-    this(requestType.toString(), requestPath, requestQuery, httpVersion);
+  public HTTPRequestHeader(HTTPRequestMethod requestMethod, String requestPath, 
+                           Map<String, String> requestQuery, String httpVersion){
+    this(requestMethod.toString(), requestPath, requestQuery, httpVersion);
   }
 
   /**
-   * Creates a new Immutable {@link HTTPRequest} object from the parts that are in a request.  This can take non-standard RequestTypes
+   * Creates a new Immutable {@link HTTPRequest} object from the parts that are in a request.  
+   * This can take non-standard request methods.
    * 
-   * @param requestType the {@link HTTPRequestType} to set.
-   * @param requestPath the {@link HTTPRequestType} to set.
+   * @param requestMethod the {@link HTTPRequestMethod} to set.
+   * @param requestPath the {@link HTTPRequestMethod} to set.
    * @param requestQuery the query to set.
    * @param httpVersion the httpVersion to set.
    */
-  public HTTPRequestHeader(String requestType, String requestPath, Map<String, String> requestQuery, String httpVersion){
-    this.requestType = requestType;
+  public HTTPRequestHeader(String requestMethod, String requestPath, 
+                           Map<String, String> requestQuery, String httpVersion){
+    this.requestMethod = requestMethod;
     final LinkedHashMap<String, String> rqm = new LinkedHashMap<>();
     int queryParamPos = requestPath.indexOf("?");
     if(queryParamPos >= 0) {
@@ -89,12 +92,13 @@ public HTTPRequestHeader(String requestType, String requestPath, Map<String, Str
     } else {
       this.requestQuery = Collections.unmodifiableMap(rqm);
     }
-    if(!HTTPConstants.HTTP_VERSION_1_1.equals(httpVersion) && !HTTPConstants.HTTP_VERSION_1_0.equals(httpVersion)) {
+    if(!HTTPConstants.HTTP_VERSION_1_1.equals(httpVersion) && 
+       !HTTPConstants.HTTP_VERSION_1_0.equals(httpVersion)) {
       throw new UnsupportedOperationException("Unknown HTTP Version!:"+httpVersion);
     }
     this.httpVersion = httpVersion.trim().toUpperCase();
     StringBuilder sb = new StringBuilder();
-    sb.append(requestType.toString());
+    sb.append(requestMethod.toString());
     sb.append(HTTPConstants.SPACE);
     sb.append(requestPath);
     if(requestQuery != null && ! requestQuery.isEmpty()) {
@@ -106,12 +110,12 @@ public HTTPRequestHeader(String requestType, String requestPath, Map<String, Str
   }
 
   /**
-   * Gets the requestType set in this request.
+   * Gets the http request method (ie POST, GET, HEAD, etc).
    * 
-   * @return the request type.
+   * @return the request method.
    */
-  public String getRequestType() {  // TODO - rename to method?
-    return requestType;
+  public String getRequestMethod() {
+    return requestMethod;
   }
 
   /**

protocol/src/main/java/org/threadly/litesockets/protocols/http/response/HTTPResponseHeader.java

@@ -25,7 +25,8 @@ public HTTPResponseHeader(final String responseHeader) {
     String[] tmp = rawResponse.split(" ", MAX_RESPONSE_ITEMS);
     try {
       httpVersion = tmp[0].trim();
-      if(!httpVersion.equalsIgnoreCase(HTTPConstants.HTTP_VERSION_1_1) && !httpVersion.equalsIgnoreCase(HTTPConstants.HTTP_VERSION_1_0)) {
+      if(!httpVersion.equalsIgnoreCase(HTTPConstants.HTTP_VERSION_1_1) && 
+         !httpVersion.equalsIgnoreCase(HTTPConstants.HTTP_VERSION_1_0)) {
         throw new IllegalArgumentException("Unknown HTTP Version!:"+httpVersion);
       }
       hrc = HTTPResponseCode.findResponseCode(Integer.parseInt(tmp[1].trim()));
@@ -42,7 +43,8 @@ public HTTPResponseHeader(final String responseHeader) {
    * @throws IllegalArgumentException If the header fails to parse.
    */
   public HTTPResponseHeader(final HTTPResponseCode rCode, final String httpVersion) {
-    if(!httpVersion.equals(HTTPConstants.HTTP_VERSION_1_1) && !httpVersion.equals(HTTPConstants.HTTP_VERSION_1_0)) {
+    if(!httpVersion.equals(HTTPConstants.HTTP_VERSION_1_1) && 
+       !httpVersion.equals(HTTPConstants.HTTP_VERSION_1_0)) {
       throw new IllegalArgumentException("Unknown HTTP Version!:"+httpVersion);
     }
     hrc = rCode;

protocol/src/main/java/org/threadly/litesockets/protocols/http/shared/HTTPConstants.java

@@ -59,7 +59,7 @@ public static enum PROTOCOL {
       new HTTPHeaders(HTTPConstants.DEFAULT_HEADERS_MAP);
 
   public static final HTTPRequestHeader DEFAULT_REQUEST_HEADER = 
-      new HTTPRequestHeader(HTTPRequestType.GET, "/", null, HTTPConstants.HTTP_VERSION_1_1);
+      new HTTPRequestHeader(HTTPRequestMethod.GET, "/", null, HTTPConstants.HTTP_VERSION_1_1);
 
   public static final HTTPResponseHeader OK_RESPONSE_HEADER = 
       new HTTPResponseHeader(HTTPResponseCode.OK, HTTPConstants.HTTP_VERSION_1_1);

…otocols/http/shared/HTTPRequestType.java …ocols/http/shared/HTTPRequestMethod.javaprotocol/src/main/java/org/threadly/litesockets/protocols/http/shared/HTTPRequestType.java renamed to protocol/src/main/java/org/threadly/litesockets/protocols/http/shared/HTTPRequestMethod.java protocol/src/main/java/org/threadly/litesockets/protocols/http/shared/HTTPRequestType.java renamed to protocol/src/main/java/org/threadly/litesockets/protocols/http/shared/HTTPRequestMethod.java

@@ -1,11 +1,11 @@
 package org.threadly.litesockets.protocols.http.shared;
 
 /**
- * Enum of Http Request types. 
+ * Enum of Http Request methods. 
  * 
  * @author lwahlmeier
  *
  */
-public enum HTTPRequestType {
+public enum HTTPRequestMethod {
   OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, CONNECT
 }