Play Framework/Scala example source code file (FakeRequest.java)

This example Play Framework source code file (FakeRequest.java) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Play Framework (and Scala) source code examples by using tags.

All credit for the original source code belongs to Play Framework; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Play Framework tags/keywords

anycontentasjson, anycontentasraw, api, content-type, fakerequest, hashmap, lib, library, map, module, mvc, play, play framework, seq, string, suppresswarnings

The FakeRequest.java Play Framework example source code

/*
 * Copyright (C) 2009-2013 Typesafe Inc. <http://www.typesafe.com>
 */
package play.test;

import com.fasterxml.jackson.databind.JsonNode;
import play.api.libs.json.JsValue;
import play.api.mvc.AnyContent;
import play.api.mvc.AnyContentAsJson;
import play.api.mvc.AnyContentAsRaw;
import play.api.mvc.AnyContentAsText;
import play.api.mvc.AnyContentAsXml;
import play.api.mvc.RawBuffer;
import play.libs.*;
import play.mvc.*;

import java.util.*;
import org.xml.sax.InputSource;
import scala.collection.Seq;

/**
 * Fake HTTP request implementation.
 */
public class FakeRequest {

    @SuppressWarnings("rawtypes")
    play.api.test.FakeRequest fake;

    /**
     * Constructs a new GET / fake request.
     */
    public FakeRequest() {
        this.fake = play.api.test.FakeRequest.apply();
    }

    /**
     * Constructs a new request.
     */
    public FakeRequest(String method, String path) {
        this.fake = play.api.test.FakeRequest.apply(method, path);
    }

    /**
     * Add additional headers to this request.
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withHeader(String name, String value) {
        fake = fake.withHeaders(Scala.varargs(Scala.Tuple(name, value)));
        return this;
    }

    /**
     * Set a AnyContent to this request.
     * @param content the AnyContent
     * @param contentType Content-Type header value
     * @param method The method to be set
     * @return the Fake Request
     */
    public FakeRequest withAnyContent(AnyContent content, String contentType, String method) {
        Map<String, Seq<String>> map = new HashMap<String, Seq<String>>(Scala.asJava(fake.headers().toMap()));
        map.put("Content-Type", Scala.toSeq(new String[] {contentType}));
        fake = new play.api.test.FakeRequest(method, fake.uri(), new play.api.test.FakeHeaders(Scala.asScala(map).toSeq()), content, fake.remoteAddress(), fake.version(), fake.id(), fake.tags(), fake.secure());
        return this;
    }

    /**
     * Set a Json Body to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>application/json</tt>.
     * @param node the Json Node
     * @return the Fake Request
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withJsonBody(JsonNode node) {
        return withJsonBody(play.api.libs.json.JacksonJson$.MODULE$.jsonNodeToJsValue(node));
    }

    /**
     * Set a Json Body to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>application/json</tt>.
     * @param json the JsValue
     * @return the Fake Request
     */
    public FakeRequest withJsonBody(JsValue json) {
        return withAnyContent(new AnyContentAsJson(json), "application/json", this.fake.getMethod());
    }

    /**
     * Set a Json Body to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>application/json</tt>.
     * @param node the Json Node
     * @param method the HTTP method. <tt>POST</tt> if set to <code>null</code>
     * @return the Fake Request
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withJsonBody(JsonNode node, String method) {
        if (method == null) {
            method = Helpers.POST;
        }
        Map<String, Seq<String>> map = new HashMap<String, Seq<String>>(Scala.asJava(fake.headers().toMap()));
        map.put("Content-Type", Scala.toSeq(new String[] {"application/json"}));
        AnyContentAsJson content =
            new AnyContentAsJson(play.api.libs.json.JacksonJson$.MODULE$.jsonNodeToJsValue(node));
        fake = new play.api.test.FakeRequest(method, fake.uri(), new play.api.test.FakeHeaders(Scala.asScala(map).toSeq()), content, fake.remoteAddress(), fake.version(), fake.id(), fake.tags(), fake.secure());
        return this;
    }

    /**
     * Set a Json Body to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>application/json</tt>.
     * @param json the JsValue
     * @param method the HTTP method. <tt>POST</tt> if set to <code>null</code>
     * @return the Fake Request
     */
    public FakeRequest withJsonBody(JsValue json, String method) {
        return withAnyContent(new AnyContentAsJson(json), "application/json", method);
    }

    /**
     * Add addtional session to this request.
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withFlash(String name, String value) {
        fake = fake.withFlash(Scala.varargs(Scala.Tuple(name, value)));
        return this;
    }

    /**
     * Add addtional session to this request.
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withSession(String name, String value) {
        fake = fake.withSession(Scala.varargs(Scala.Tuple(name, value)));
        return this;
    }

    /**
     * Add cookies to this request
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withCookies(Http.Cookie... cookies) {
        List <play.api.mvc.Cookie> scalacookies = new ArrayList<play.api.mvc.Cookie>();
        for (Http.Cookie c : cookies) {
            scalacookies.add(new play.api.mvc.Cookie(c.name(), c.value(), Scala.<Object>Option(c.maxAge()), c.path(), Scala.Option(c.domain()), c.secure(), c.httpOnly()) );
        }
        fake = fake.withCookies(Scala.varargs(scalacookies.toArray()));
        return this;
    }

    /**
     * Set a Form url encoded body to this request.
     */
    @SuppressWarnings(value = "unchecked")
    public FakeRequest withFormUrlEncodedBody(java.util.Map<String,String> data) {
        List<scala.Tuple2<String,String>> args = new ArrayList<scala.Tuple2<String,String>>();
        for(String key: data.keySet()) {
            scala.Tuple2<String,String> pair = Scala.Tuple(key, data.get(key));
            args.add(pair);
        }
        fake = fake.withFormUrlEncodedBody(Scala.toSeq(args));
        return this;
    }

    @SuppressWarnings(value = "unchecked")
    public play.api.mvc.Request<play.mvc.Http.RequestBody> getWrappedRequest() {
        return ((play.api.test.FakeRequest<play.api.mvc.AnyContent>)fake).map(new scala.runtime.AbstractFunction1<play.api.mvc.AnyContent, play.mvc.Http.RequestBody>() {
            public play.mvc.Http.RequestBody apply(play.api.mvc.AnyContent anyContent) {
                return new play.core.j.JavaParsers.DefaultRequestBody(
                        anyContent.asFormUrlEncoded(),
                        anyContent.asRaw(),
                        anyContent.asText(),
                        anyContent.asJson(),
                        anyContent.asXml(),
                        anyContent.asMultipartFormData(),
                        false
                        );
            }
        });
    }

    /**
     * Set a Binary Data to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>application/octet-stream</tt>.
     * @param data the Binary Data
     * @return the Fake Request
     */
    public FakeRequest withRawBody(byte[] data) {
        return withAnyContent(new AnyContentAsRaw(new RawBuffer(data.length, data)), "application/octet-stream", this.fake.getMethod());
    }

    /**
     * Set a XML to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>application/xml</tt>.
     * @param xml the XML
     * @return the Fake Request
     */
    public FakeRequest withXmlBody(InputSource xml) {
        return withAnyContent(new AnyContentAsXml(scala.xml.XML.load(xml)), "application/xml", this.fake.getMethod());
    }

    /**
     * Set a Text to this request.
     * The <tt>Content-Type</tt> header of the request is set to <tt>text/plain</tt>.
     * @param text the text
     * @return the Fake Request
     */
    public FakeRequest withTextBody(String text) {
        return withAnyContent(new AnyContentAsText(text), "text/plain", this.fake.getMethod());
    }

    /**
     * Set a any body to this request.
     * @param body the Body
     * @return the Fake Request
     */
    public <T> FakeRequest withBody(T body) {
        this.fake = this.fake.withBody(body);
        return this;
    }
}