Java Servlet Programming, 2nd Edition > B. HTTP Servlet API Quick Reference > HttpServletResponse |
SynopsisInterface Name: javax.servlet.http.HttpServletResponse Superinterface: javax.servlet.ServletResponse Immediate Subinterfaces: None Implemented By: None Availability: Servlet API 1.0 and later DescriptionHttpServletResponse extends the ServletResponse class to allow manipulation of HTTP protocol-specific data, including response headers and status codes. It also defines a series of constants that represent various HTTP status codes and includes helper functions for session-tracking operations. Interface Declarationpublic interface HttpServletResponse extends javax.servlet.ServletResponse { // Constants public static final int SC_ACCEPTED; public static final int SC_BAD_GATEWAY; public static final int SC_BAD_REQUEST; public static final int SC_CONFLICT; public static final int SC_CONTINUE; // New in 2.0 public static final int SC_CREATED; public static final int SC_EXPECTATION_FAILED; // New in 2.2 public static final int SC_FORBIDDEN; public static final int SC_GATEWAY_TIMEOUT; // New in 2.0 public static final int SC_GONE; // New in 2.0 public static final int SC_HTTP_VERSION_NOT_SUPPORTED; // New in 2.0 public static final int SC_INTERNAL_SERVER_ERROR; public static final int SC_LENGTH_REQUIRED; // New in 2.0 public static final int SC_METHOD_NOT_ALLOWED; // New in 2.0 public static final int SC_MOVED_PERMANENTLY; public static final int SC_MOVED_TEMPORARILY; public static final int SC_MULTIPLE_CHOICES; // New in 2.0 public static final int SC_NO_CONTENT; public static final int SC_NON_AUTHORITATIVE_INFORMATION; // New in 2.0 public static final int SC_NOT_ACCEPTABLE; // New in 2.0 public static final int SC_NOT_FOUND; public static final int SC_NOT_IMPLEMENTED; public static final int SC_NOT_MODIFIED; public static final int SC_OK; public static final int SC_PARTIAL_CONTENT; // New in 2.0 public static final int SC_PAYMENT_REQUIRED; // New in 2.0 public static final int SC_PRECONDITION_FAILED; // New in 2.0 public static final int SC_PROXY_AUTHENTICATION_REQUIRED; // New in 2.0 public static final int SC_REQUEST_ENTITY_TOO_LARGE; // New in 2.0 public static final int SC_REQUEST_TIMEOUT; // New in 2.0 public static final int SC_REQUEST_URI_TOO_LONG; // New in 2.0 public static final int SC_REQUESTED_RANGE_NOT_SATISFIABLE;// New in 2.2 public static final int SC_RESET_CONTENT; // New in 2.0 public static final int SC_SEE_OTHER; // New in 2.0 public static final int SC_SERVICE_UNAVAILABLE; public static final int SC_SWITCHING_PROTOCOLS; // New in 2.0 public static final int SC_UNAUTHORIZED; public static final int SC_UNSUPPORTED_MEDIA_TYPE; // New in 2.0 public static final int SC_USE_PROXY; // New in 2.0 // Methods public abstract void addCookie(Cookie cookie); // New in 2.0 public abstract void addDateHeader(String name, long date);// New in 2.2 public abstract void addHeader(String name, String value);// New in 2.2 public abstract void addIntHeader(String name, int value);// New in 2.2 public abstract boolean containsHeader(String name); public abstract String encodeRedirectUrl(String url); // Deprecated public abstract String encodeRedirectURL(String url); // New in 2.1 public abstract String encodeUrl(String url); // Deprecated public abstract String encodeURL(String url); // New in 2.1 public abstract void sendError(int sc) throws IOException, IllegalStateException; public abstract void sendError(int sc, String msg) throws IOException, IllegalStateException; public abstract void sendRedirect(String location) throws IOException, IllegalStateException; public abstract void setDateHeader(String name, long date); public abstract void setHeader(String name, String value); public abstract void setIntHeader(String name, int value); public abstract void setStatus(int sc); public abstract void setStatus(int sc, String sm); // Deprecated } ConstantsAppendix D contains complete descriptions of all the SC_XXX status codes. MethodsaddCookie()public abstract void addCookie(Cookie cookie)
addDateHeader()public abstract void addDateHeader(String name, long date)
addHeader()public abstract void addHeader(String name, String value)
addIntHeader()public abstract void addIntHeader(String name, int value)
containsHeader()public abstract boolean containsHeader(String name)
encodeRedirectURL()public abstract String encodeRedirectUrl(String url) public abstract String encodeRedirectURL(String url)
encodeURL()public abstract String encodeUrl(String url) public abstract String encodeURL(String url)
sendError()public abstract void sendError(int sc) throws IOException, IllegalStateException public abstract void sendError(int sc, String msg) throws IOException, IllegalStateException
sendRedirect()public abstract void sendRedirect(String location) throws IOException, IllegalStateException
setDateHeader()public abstract void setDateHeader(String name, long date)
setHeader()public abstract void setHeader(String name, String value)
setIntHeader()public abstract void setIntHeader(String name, int value)
setStatus()public abstract void setStatus(int sc) public abstract void setStatus(int sc, String sm)
|