Exceptions and HTTP

In many situations, you may want to use common HTTP status codes to indicate the success or failure of a user's API request. For example, if a user is attempting to retrieve an entity which does not exist, you may want to send an HTTP 404 status code saying No entity exists with ID: entityId.

You can send such common HTTP status codes by throwing an exception provided by the endpoints library as follows:

String message = "No entity exists with ID: " + entityId;
throw new NotFoundException(message);

Exceptions Provided by Endpoints

The endpoints library provides the following exceptions, corresponding to specific HTTP status codes:

Supported HTTP Status Codes

Endpoints supports a subset of HTTP status codes in API responses. The following table describes the supported codes.

Creating Your Own Exception Classes

If you want to create other exception classes for other HTTP status codes, you can do so by subclassing com.google.api.server.spi.ServiceException. The following snippet shows how to create an exception class that represents an HTTP 408 status code:

import com.google.api.server.spi.ServiceException;

public class RequestTimeoutException extends ServiceException {
    public RequestTimeoutException(String message) {
        super(408, message);
    }
}

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.