Return HTTP Status "created" in Play! Framework

Question

I have a create action in a Play! framework controller that should return the HTTP status code Created and redirect the client to the location of the created object.

public class SomeController extends Controller {

    public static void create() {
        Something something = new Something();
        something.save();
        response.status = StatusCode.CREATED;  // Doesn't work!
        show(something.id);
    }

    public static void show(long id) {
        render(Something.findById(id));
    }
}

See also method chaining in the Play! framework documentation.

The code above returns the status code 302 Found instead of 201 Created. What can I do to let Play return the correct status (and Location header)?

score 6 · Accepted Answer · edited Feb 08 '18 at 11:43

6

The reason this is happening, is that once you created your something, you are then telling play to Show your something, through calling the show action.

To achieve this, play is performing a redirect (to maintain its RESTful state), to tell the browser that as a result of calling the create() action, it must now redirect to the show() action.

So, you have a couple of options.

Don't render a response, and let the client side handle where it goes after creating it (not ideal).
Instead of calling show(), simply render it yourself in the create() method...

To use option 2, it may look like the following:

public static void create() {
    Something something = new Something();
    something.save();
    response.status = StatusCode.CREATED;
    renderTemplate("Application/show.html", something);
}

edited Feb 08 '18 at 11:43

o-0

1,630
12
27

answered Sep 18 '11 at 14:59

Codemwnci

51,224
10
90
127

1

`201 Created` should be send together with a `Location` header which would not happen with solution 2. Could you please explain solution 1, I don't understand it? – deamon Sep 18 '11 at 17:14
Solution 1 is not good. It is basically saying, after your request create, then request show(), so your flow is decided client side (i.e. javascript), rather than serverside in your action. – Codemwnci Sep 18 '11 at 17:30
3

I have checked the source code for Play (1.2.3) and the Redirect object, has a code, which is defaulted to 302. It has a constructor to offer a different code, but this constructor does not appear to be used in the framework. – Codemwnci Sep 18 '11 at 17:53

score 1 · Answer 2 · answered Jun 30 '12 at 18:04

1

Example code for setting the status code in Play framework: Response.current().status = Http.StatusCode.CREATED;

answered Jun 30 '12 at 18:04

Robert de W

286
6
24

score 0 · Answer 3 · edited Feb 08 '18 at 06:13

In the play framework, calling another action performs a redirect except that the action called is not public. So, here is one of the solutions:

public class SomeController extends Controller {

    public static void create() {
        Something something = new Something();
        something.save();
        response.status = StatusCode.CREATED;  // Doesn't work!
        show(something.id);
    }

    private static void show(long id) {
        render(Something.findById(id));
    }
}

Return HTTP Status "created" in Play! Framework

3 Answers3