com.squareup.okhttp.mockwebserver.RecordedRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.squareup.okhttp.mockwebserver Show documentation
There is a newer version: 2.4.0
Show newest version
/*
 * Copyright (C) 2011 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.squareup.okhttp.mockwebserver;

import java.io.UnsupportedEncodingException;
import java.net.Socket;
import java.util.ArrayList;
import java.util.List;
import javax.net.ssl.SSLSocket;

/** An HTTP request that came into the mock web server. */
public final class RecordedRequest {
  private final String requestLine;
  private final String method;
  private final String path;
  private final List headers;
  private final List chunkSizes;
  private final long bodySize;
  private final byte[] body;
  private final int sequenceNumber;
  private final String sslProtocol;

  public RecordedRequest(String requestLine, List headers, List chunkSizes,
      long bodySize, byte[] body, int sequenceNumber, Socket socket) {
    this.requestLine = requestLine;
    this.headers = headers;
    this.chunkSizes = chunkSizes;
    this.bodySize = bodySize;
    this.body = body;
    this.sequenceNumber = sequenceNumber;
    this.sslProtocol = socket instanceof SSLSocket
        ? ((SSLSocket) socket).getSession().getProtocol()
        : null;

    if (requestLine != null) {
      int methodEnd = requestLine.indexOf(' ');
      int pathEnd = requestLine.indexOf(' ', methodEnd + 1);
      this.method = requestLine.substring(0, methodEnd);
      this.path = requestLine.substring(methodEnd + 1, pathEnd);
    } else {
      this.method = null;
      this.path = null;
    }
  }

  public String getRequestLine() {
    return requestLine;
  }

  public String getMethod() {
    return method;
  }

  public String getPath() {
    return path;
  }

  /** Returns all headers. */
  public List getHeaders() {
    return headers;
  }

  /**
   * Returns the first header named {@code name}, or null if no such header
   * exists.
   */
  public String getHeader(String name) {
    name += ":";
    for (int i = 0, size = headers.size(); i < size; i++) {
      String header = headers.get(i);
      if (name.regionMatches(true, 0, header, 0, name.length())) {
        return header.substring(name.length()).trim();
      }
    }
    return null;
  }

  /** Returns the headers named {@code name}. */
  public List getHeaders(String name) {
    List result = new ArrayList<>();
    name += ":";
    for (int i = 0, size = headers.size(); i < size; i++) {
      String header = headers.get(i);
      if (name.regionMatches(true, 0, header, 0, name.length())) {
        result.add(header.substring(name.length()).trim());
      }
    }
    return result;
  }

  /**
   * Returns the sizes of the chunks of this request's body, or an empty list
   * if the request's body was empty or unchunked.
   */
  public List getChunkSizes() {
    return chunkSizes;
  }

  /**
   * Returns the total size of the body of this POST request (before
   * truncation).
   */
  public long getBodySize() {
    return bodySize;
  }

  /** Returns the body of this POST request. This may be truncated. */
  public byte[] getBody() {
    return body;
  }

  /** Returns the body of this POST request decoded as a UTF-8 string. */
  public String getUtf8Body() {
    try {
      return new String(body, "UTF-8");
    } catch (UnsupportedEncodingException e) {
      throw new AssertionError();
    }
  }

  /**
   * Returns the index of this request on its HTTP connection. Since a single
   * HTTP connection may serve multiple requests, each request is assigned its
   * own sequence number.
   */
  public int getSequenceNumber() {
    return sequenceNumber;
  }

  /**
   * Returns the connection's SSL protocol like {@code TLSv1}, {@code SSLv3},
   * {@code NONE} or null if the connection doesn't use SSL.
   */
  public String getSslProtocol() {
    return sslProtocol;
  }

  @Override public String toString() {
    return requestLine;
  }
}