Interface RestCollectionCreateView<P extends RestResource,​C extends RestResource,​I>

    • Method Detail

      • apply

        Response<?> apply​(P parentResource,
                          IdString id,
                          I input)
                   throws Exception
        Process the view operation by creating the resource.

        The returned response defines the status code that is returned to the client. For RestCollectionCreateViews this is usually 201 Created because a resource is created, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).

        The value of the returned response is automatically converted to JSON unless it is a BinaryResult.

        Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.

        Parameters:
        parentResource - parent resource of the resource that should be created
        id - the ID of the child resource that should be created
        input - input after parsing from request.
        Returns:
        response to return to the client
        Throws:
        RestApiException - if the resource creation is rejected
        Exception - the implementation of the view failed. The exception will be logged and HTTP 500 Internal Server Error will be returned to the client.