How do I send a response status in Servlet?

package org.kodejava.servlet;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebServlet(name = "ResponseStatusServlet", urlPatterns = "/response-status")
public class ResponseStatus extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doPost(request, response);
    }

    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        // All response status is defined in the HttpServletResponse class. We
        // can then use these constants value to return process status to the
        // browser.
        response.setContentType("text/html");

        // Let say this servlet only handle request for page name inputForm. So
        // when user request for other page name error page not found 404 will
        // be returned, otherwise it will be 200 which mean OK.
        String page = request.getParameter("page");
        if (page != null && page.equals("inputForm")) {
            response.setStatus(HttpServletResponse.SC_OK);
        } else {
            final String message = "The requested page [" + page + "] not found.";
            response.sendError(HttpServletResponse.SC_NOT_FOUND, message);
        }
    }
}

Here is a list of all available status code that are defined in the HttpServletResponse class.

STATUS CODE DESCRIPTION
SC_ACCEPTED Status code (202) indicating that a request was accepted for processing, but was not completed
SC_BAD_GATEWAY Status code (502) indicating that the HTTP server received an invalid response from a server it consulted when acting as a proxy or gateway
SC_BAD_REQUEST Status code (400) indicating the request sent by the client was syntactically incorrect
SC_CONFLICT Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource
SC_CONTINUE Status code (100) indicating the client can continue
SC_CREATED Status code (201) indicating the request succeeded and created a new resource on the server
SC_EXPECTATION_FAILED Status code (417) indicating that the server could not meet the expectation given in the Expect request header
SC_FORBIDDEN Status code (403) indicating the server understood the request but refused to fulfill it
SC_FOUND Status code (302) indicating that the resource reside temporarily under a different URI
SC_GATEWAY_TIMEOUT Status code (504) indicating that the server did not receive a timely response from the upstream server while acting as a gateway or proxy
SC_GONE Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known
SC_HTTP_VERSION_NOT_SUPPORTED Status code (505) indicating that the server does not support or refuses to support the HTTP protocol version that was used in the request message
SC_INTERNAL_SERVER_ERROR Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request
SC_LENGTH_REQUIRED Status code (411) indicating that the request cannot be handled without a defined Content-Length
SC_METHOD_NOT_ALLOWED Status code (405) indicating that the method specified in the Request-Line is not allowed for the resource identified by the Request-URI
SC_MOVED_PERMANENTLY Status code (301) indicating that the resource has permanently moved to a new location, and that future references should use a new URI with their requests
SC_MOVED_TEMPORARILY Status code (302) indicating that the resource has temporarily moved to another location, but that future references should still use the original URI to access the resource
SC_MULTIPLE_CHOICES Status code (300) indicating that the requested resource corresponds to any one of a set of representations, each with its own specific location
SC_NO_CONTENT Status code (204) indicating that the request succeeded but that there was no new information to return
SC_NON_AUTHORITATIVE_INFORMATION Status code (203) indicating that the meta information presented by the client did not originate from the server
SC_NOT_ACCEPTABLE Status code (406) indicating that the resource identified by the request is only capable of generating response entities which have content characteristics not acceptable according to the accept headers sent in the request
SC_NOT_FOUND Status code (404) indicating that the requested resource is not available
SC_NOT_IMPLEMENTED Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request
SC_NOT_MODIFIED Status code (304) indicating that a conditional GET operation found that the resource was available and not modified
SC_OK Status code (200) indicating the request succeeded normally
SC_PARTIAL_CONTENT Status code (206) indicating that the server has fulfilled the partial GET request for the resource
SC_PAYMENT_REQUIRED Status code (402) reserved for future use
SC_PRECONDITION_FAILED Status code (412) indicating that the precondition given in one or more of the request-header fields evaluated to false when it was tested on the server
SC_PROXY_AUTHENTICATION_REQUIRED Status code (407) indicating that the client MUST first authenticate itself with the proxy
SC_REQUEST_ENTITY_TOO_LARGE Status code (413) indicating that the server is refusing to process the request because the request entity is larger than the server is willing or able to process
SC_REQUEST_TIMEOUT Status code (408) indicating that the client did not produce a request within the time that the server was prepared to wait
SC_REQUEST_URI_TOO_LONG Status code (414) indicating that the server is refusing to service the request because the Request-URI is longer than the server is willing to interpret
SC_REQUESTED_RANGE_NOT_SATISFIABLE Status code (416) indicating that the server cannot serve the requested byte range
SC_RESET_CONTENT Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent
SC_SEE_OTHER Status code (303) indicating that the response to the request can be found under a different URI
SC_SERVICE_UNAVAILABLE Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request
SC_SWITCHING_PROTOCOLS Status code (101) indicating the server is switching protocols according to Upgrade header
SC_TEMPORARY_REDIRECT Status code (307) indicating that the requested resource resides temporarily under a different URI
SC_UNAUTHORIZED Status code (401) indicating that the request requires HTTP authentication
SC_UNSUPPORTED_MEDIA_TYPE Status code (415) indicating that the server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method
SC_USE_PROXY Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field

Maven dependencies

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
</dependency>

Maven Central

Wayan

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.