org.threadly.litesockets.protocols.http.request.HTTPRequest Maven / Gradle / Ivy

Go to download
package org.threadly.litesockets.protocols.http.request;

import java.nio.ByteBuffer;

import org.threadly.litesockets.buffers.SimpleMergedByteBuffers;
import org.threadly.litesockets.protocols.http.shared.HTTPConstants;
import org.threadly.litesockets.protocols.http.shared.HTTPHeaders;
import org.threadly.litesockets.protocols.http.shared.HTTPParsingException;

/**
 * This is an immutable HTTPRequest object.  This is what is sent to the server when doing an
 * HTTPRequest.  This object is created via {@link HTTPRequestBuilder}. 
 */
public class HTTPRequest {
  public static final int DEFAULT_TIMEOUT_MS = 20000;
  public static final int MIN_TIMEOUT_MS = 500;
  
  private final HTTPRequestHeader request;
  private final HTTPHeaders headers;

  protected HTTPRequest(HTTPRequestHeader request, HTTPHeaders headers) {
    this.request = request;
    this.headers = headers;
  }

  /**
   * Returns the {@link HTTPHeaders} object for this request.
   * 
   * @return the {@link HTTPHeaders} object for this request.
   */
  public HTTPHeaders getHTTPHeaders() {
    return headers;
  }

  /**
   * Returns the {@link HTTPRequestHeader} object for this request.
   * 
   * @return the {@link HTTPRequestHeader} object for this request.
   */
  public HTTPRequestHeader getHTTPRequestHeader() {
    return request;
  }

  /**
   * Returns a {@link ByteBuffer} for this header.  The buffer is read-only.
   * 
   * @deprecated Please use {@link #getMergedByteBuffers()} to avoid copying the data
   * 
   * @return a {@link ByteBuffer} for this header
   */
  @Deprecated
  public ByteBuffer getByteBuffer() {
    ByteBuffer combined = ByteBuffer.allocate(headers.toString().length() + request.length() + 
        HTTPConstants.HTTP_NEWLINE_DELIMINATOR.length() + 
        HTTPConstants.HTTP_NEWLINE_DELIMINATOR.length());

    combined.put(request.getByteBuffer());
    combined.put(HTTPConstants.HTTP_NEWLINE_DELIMINATOR.getBytes());
    combined.put(headers.toString().getBytes());
    combined.put(HTTPConstants.HTTP_NEWLINE_DELIMINATOR.getBytes());
    combined.flip();
    return combined.asReadOnlyBuffer();
  }

  /**
   * Returns a {@link ByteBuffer} for this header.  The buffer is read-only.
   * 
   * @return a {@link ByteBuffer} for this header
   */
  public SimpleMergedByteBuffers getMergedByteBuffers() {
    return new SimpleMergedByteBuffers(true, 
                                       request.getByteBuffer(), 
                                       HTTPConstants.HTTP_NEWLINE_DELIMINATOR_BUFFER.duplicate(), 
                                       ByteBuffer.wrap(headers.toString().getBytes()), 
                                       HTTPConstants.HTTP_NEWLINE_DELIMINATOR_BUFFER.duplicate());
  }

  @Override
  public String toString() {
    return request.toString()+
        HTTPConstants.HTTP_NEWLINE_DELIMINATOR+
        headers.toString()+
        HTTPConstants.HTTP_NEWLINE_DELIMINATOR;
  }

  @Override
  public int hashCode() {
    return request.hashCode() ^ headers.hashCode();
  }

  @Override
  public boolean equals(Object o) {
    if(o == this) {
      return true;
    } else if(o instanceof HTTPRequest) {
      HTTPRequest hr = (HTTPRequest)o;
      if(hr.request.equals(request) && hr.headers.equals(headers)) {
        return true;
      }
    }
    return false;
  }

  /**
   * Create an {@link HTTPRequestBuilder} from this header.
   * 
   * @return an {@link HTTPRequestBuilder} based on this HTTPRequest.
   */
  public HTTPRequestBuilder makeBuilder() {
    HTTPRequestBuilder hrb = new HTTPRequestBuilder().replaceHTTPHeaders(headers).setHTTPRequestHeader(request);
    return hrb;
  }


  /**
   * Creates a new {@link HTTPRequestBuilder}.
   * 
   * @return a new {@link HTTPRequestBuilder}.
   */
  public static HTTPRequestBuilder builder() {
    return new HTTPRequestBuilder();
  }

  /**
   * Creates a new {@link HTTPRequest} object from a string.
   * 
   * @param request the HTTP Request string to parse.
   * @return an {@link HTTPRequest} from the provided string.
   * @throws HTTPParsingException is thrown if there are any problems parsing the HTTPRequest.
   */
  public static HTTPRequest parseRequest(final String request) throws HTTPParsingException {
    try {
      String reqh = request.substring(request.indexOf(HTTPConstants.HTTP_NEWLINE_DELIMINATOR));
      HTTPRequestHeader hrh = new HTTPRequestHeader(reqh);
      HTTPHeaders hh = new HTTPHeaders(request.substring(reqh.length()+HTTPConstants.HTTP_NEWLINE_DELIMINATOR.length(), request.length()));
      return new HTTPRequest(hrh, hh);
    } catch(Exception e) {
      throw new HTTPParsingException(e);
    }
  }
}