src/main/java/com/google/mockwebserver/RecordedRequest.java

/*
 * 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.google.mockwebserver;

import java.io.UnsupportedEncodingException;
import java.net.Socket;
import java.security.Principal;
import java.security.cert.Certificate;
import java.util.ArrayList;
import java.util.List;

import javax.net.ssl.SSLPeerUnverifiedException;
import javax.net.ssl.SSLSession;
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<String> headers;
    private final List<Integer> chunkSizes;
    private final int bodySize;
    private final byte[] body;
    private final int sequenceNumber;
    private final String sslProtocol;
    private final String sslCipherSuite;
    private final Principal sslLocalPrincipal;
    private final Principal sslPeerPrincipal;
    private final Certificate[] sslLocalCertificates;
    private final Certificate[] sslPeerCertificates;

    public RecordedRequest(String requestLine, List<String> headers, List<Integer> chunkSizes,
            int 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;

        if (socket instanceof SSLSocket) {
            SSLSocket sslSocket = (SSLSocket) socket;
            SSLSession session = sslSocket.getSession();
            sslProtocol = session.getProtocol();
            sslCipherSuite = session.getCipherSuite();
            sslLocalPrincipal = session.getLocalPrincipal();
            sslLocalCertificates = session.getLocalCertificates();
            Principal peerPrincipal = null;
            Certificate[] peerCertificates = null;
            try {
                peerPrincipal = session.getPeerPrincipal();
                peerCertificates = session.getPeerCertificates();
            } catch (SSLPeerUnverifiedException e) {
                // No-op: use nulls instead
            }
            sslPeerPrincipal = peerPrincipal;
            sslPeerCertificates = peerCertificates;
        } else {
            sslProtocol = null;
            sslCipherSuite = null;
            sslLocalPrincipal = null;
            sslLocalCertificates = null;
            sslPeerPrincipal = null;
            sslPeerCertificates = 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<String> getHeaders() {
        return headers;
    }

    /**
     * Returns the first header named {@code name}, or null if no such header
     * exists.
     */
    public String getHeader(String name) {
        name += ":";
        for (String header : headers) {
            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<String> getHeaders(String name) {
        List<String> result = new ArrayList<String>();
        name += ":";
        for (String header : headers) {
            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<Integer> getChunkSizes() {
        return chunkSizes;
    }

    /**
     * Returns the total size of the body of this POST request (before
     * truncation).
     */
    public int 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 SSL connection's protocol like {@code TLSv1}, {@code SSLv3},
     * {@code NONE} or {@code null} if the connection doesn't use SSL.
     */
    public String getSslProtocol() {
        return sslProtocol;
    }

    /**
     * Returns the SSL connection's cipher protocol retrieved using
     * {@code sslSocket.getSession().getCipherSuite()} or {@code null} if the connection doesn't
     * use SSL.
     */
    public String getSslCipherSuite() {
        return sslCipherSuite;
    }

    /**
     * Returns the SSL connection's local principal retrieved using
     * {@code sslSocket.getSession().getLocalPrincipal()} or {@code null} if the connection doesn't
     * use SSL.
     */
    public Principal getSslLocalPrincipal() {
        return sslLocalPrincipal;
    }

    /**
     * Returns the SSL connection's local certificates retrieved using
     * {@code sslSocket.getSession().getLocalCertificates()} or {@code null} if the connection
     * doesn't use SSL.
     */
    public Certificate[] getSslLocalCertificates() {
        return sslLocalCertificates;
    }

    /**
     * Returns the SSL connection's peer principal retrieved using
     * {@code sslSocket.getSession().getPeerPrincipal()}, or {@code null} if the connection doesn't
     * use SSL or the peer has not been verified.
     */
    public Principal getSslPeerPrincipal() {
        return sslPeerPrincipal;
    }

    /**
     * Returns the SSL connection's peer certificates retrieved using
     * {@code sslSocket.getSession().getPeerCertificates()}, or {@code null} if the connection
     * doesn't use SSL or the peer has not been verified.
     */
    public Certificate[] getSslPeerCertificates() {
        return sslPeerCertificates;
    }

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