Interface RestReadView<R extends RestResource>
-
- Type Parameters:
R
- type of resource the view reads.
- All Superinterfaces:
RestView<R>
- All Known Subinterfaces:
ETagView<R>
public interface RestReadView<R extends RestResource> extends RestView<R>
RestView to read a resource without modification.RestReadViews are invoked by the HTTP GET method.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Response<?>
apply(R resource)
Process the view operation by reading from the resource.
-
-
-
Method Detail
-
apply
Response<?> apply(R resource) throws AuthException, BadRequestException, ResourceConflictException, Exception
Process the view operation by reading from the resource.The value of the returned response is automatically converted to JSON unless it is a
BinaryResult
.The returned response defines the status code that is returned to the client. For RestReadViews this is usually
200 OK
, but other 2XX or 3XX status codes are also possible (e.g.Response.Redirect
can be returned for302 Found
).Throwing a subclass of
RestApiException
results in a 4XX response to the client. For any other exception the client will get a500 Internal Server Error
response.- Parameters:
resource
- resource to read- Returns:
- response to return to the client
- Throws:
AuthException
- the caller is not permitted to access this view.BadRequestException
- the request was incorrectly specified and cannot be handled by this view.ResourceConflictException
- the resource state does not permit this view to make the changes at this time.Exception
- the implementation of the view failed. The exception will be logged and HTTP 500 Internal Server Error will be returned to the client.
-
-