All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface javax.servlet.http.HttpServletResponse

public interface HttpServletResponse

extends ServletResponse

Version:

1.26, 10/20/97

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_FORBIDDEN

Status code (403) indicating the server understood the request but refused to fulfill it.

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_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 headerssent 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_NO_CONTENT

Status code (204) indicating that the request succeeded but that there was no new information to return.

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 requestwithin 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_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_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.

addCookie(Cookie)

Adds the specified cookie to the response.

containsHeader(String)

Checks whether the response message header has a field with the specified name.

encodeRedirectUrl(String)

Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged.

encodeUrl(String)

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged.

sendError(int, String)

Sends an error response to the client using the specified status code and descriptive message.

sendError(int)

Sends an error response to the client using the specified status code and a default message.

sendRedirect(String)

Sends a temporary redirect response to the client using the specified redirect location URL.

setDateHeader(String, long)

Adds a field to the response header with the given name and date-valued field.

setHeader(String, String)

Adds a field to the response header with the given name and value.

setIntHeader(String, int)

Adds a field to the response header with the given name and integer value.

setStatus(int, String)

Sets the status code and message for this response.

setStatus(int)

Sets the status code for this response.

public static final int SC_ACCEPTED

Status code (202) indicating that a request was accepted for processing, but was not completed.

public static final int 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.

public static final int SC_BAD_REQUEST

Status code (400) indicating the request sent by the client was syntactically incorrect.

public static final int SC_CONFLICT

Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource.

public static final int SC_CONTINUE

Status code (100) indicating the client can continue.

public static final int SC_CREATED

Status code (201) indicating the request succeeded and created a new resource on the server.

public static final int SC_FORBIDDEN

Status code (403) indicating the server understood the request but refused to fulfill it.

public static final int 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.

public static final int SC_GONE

Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known. This condition SHOULD be considered permanent.

public static final int 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.

public static final int SC_INTERNAL_SERVER_ERROR

Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request.

public static final int SC_LENGTH_REQUIRED

Status code (411) indicating that the request cannot be handled without a defined Content-Length.

public static final int 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.

public static final int 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.

public static final int 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.

public static final int 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.

public static final int SC_NON_AUTHORITATIVE_INFORMATION

Status code (203) indicating that the meta information presented by the client did not originate from the server.

public static final int 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 headerssent in the request.

public static final int SC_NOT_FOUND

Status code (404) indicating that the requested resource is not available.

public static final int SC_NOT_IMPLEMENTED

Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request.

public static final int SC_NOT_MODIFIED

Status code (304) indicating that a conditional GET operation found that the resource was available and not modified.

public static final int SC_NO_CONTENT

Status code (204) indicating that the request succeeded but that there was no new information to return.

public static final int SC_OK

Status code (200) indicating the request succeeded normally.

public static final int SC_PARTIAL_CONTENT

Status code (206) indicating that the server has fulfilled the partial GET request for the resource.

public static final int SC_PAYMENT_REQUIRED

Status code (402) reserved for future use.

public static final int 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.

public static final int SC_PROXY_AUTHENTICATION_REQUIRED

Status code (407) indicating that the client MUST first authenticate itself with the proxy.

public static final int 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.

public static final int SC_REQUEST_TIMEOUT

Status code (408) indicating that the client did not produce a requestwithin the time that the server was prepared to wait.

public static final int 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.

public static final int SC_RESET_CONTENT

Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent.

public static final int SC_SEE_OTHER

Status code (303) indicating that the response to the request can be found under a different URI.

public static final int SC_SERVICE_UNAVAILABLE

Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request.

public static final int SC_SWITCHING_PROTOCOLS

Status code (101) indicating the server is switching protocols according to Upgrade header.

public static final int SC_UNAUTHORIZED

Status code (401) indicating that the request requires HTTP authentication.

public static final int 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.

public static final int SC_USE_PROXY

Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field.

public abstract void addCookie(Cookie cookie)

Adds the specified cookie to the response. It can be called multiple times to set more than one cookie.

Parameters:

cookie - the Cookie to return to the client

public abstract boolean containsHeader(String name)

Checks whether the response message header has a field with the specified name.

Parameters:

name - the header field name

Returns:

true if the response message header has a field with the specified name; false otherwise

public abstract java.lang.String encodeRedirectUrl(String url)

Encodes the specified URL for use in the sendRedirect method or, if encoding is not needed, returns the URL unchanged. The implementation of this method should include the logic to determine whether the session ID needs to be encoded in the URL. Because the rules for making this determination differ from those used to decide whether to encode a normal link, this method is seperate from the encodeUrl method.

All URLs sent to the HttpServletResponse.sendRedirect method should be run through this method. Otherwise, URL rewriting canont be used with browsers which do not support cookies.

Parameters:

url - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

See Also:

sendRedirect, encodeUrl

public abstract java.lang.String encodeUrl(String url)

Encodes the specified URL by including the session ID in it, or, if encoding is not needed, returns the URL unchanged. The implementation of this method should include the logic to determine whether the session ID needs to be encoded in the URL. For example, if the browser supports cookies, or session tracking is turned off, URL encoding is unnecessary.

All URLs emitted by a Servlet should be run through this method. Otherwise, URL rewriting cannot be used with browsers which do not support cookies.

Parameters:

url - the url to be encoded.

Returns:

the encoded URL if encoding is needed; the unchanged URL otherwise.

public abstract void sendError(int sc,
                               String msg) throws IOException

Sends an error response to the client using the specified status code and descriptive message. If setStatus has previously been called, it is reset to the error status code. The message is sent as the body of an HTML page, which is returned to the user to describe the problem. The page is sent with a default HTML header; the message is enclosed in simple body tags (<body></body>).

Parameters:

sc - the status code

msg - the detail message

public abstract void sendError(int sc) throws IOException

Sends an error response to the client using the specified status code and a default message.

Parameters:

sc - the status code

Throws: IOException

If an I/O error has occurred.

public abstract void sendRedirect(String location) throws IOException

Sends a temporary redirect response to the client using the specified redirect location URL. The URL must be absolute (for example, https://hostname/path/file.html). Relative URLs are not permitted here.

Parameters:

location - the redirect location URL

Throws: IOException

If an I/O error has occurred.

public abstract void setDateHeader(String name,
                                   long date)

Adds a field to the response header with the given name and date-valued field. The date is specified in terms of milliseconds since the epoch. If the date field had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

name - the name of the header field

value - the header field's date value

See Also:

containsHeader

public abstract void setHeader(String name,
                               String value)

Adds a field to the response header with the given name and value. If the field had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

name - the name of the header field

value - the header field's value

See Also:

containsHeader

public abstract void setIntHeader(String name,
                                  int value)

Adds a field to the response header with the given name and integer value. If the field had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

name - the name of the header field

value - the header field's integer value

See Also:

containsHeader

public abstract void setStatus(int sc,
                               String sm)

Sets the status code and message for this response. If the field had already been set, the new value overwrites the previous one. The message is sent as the body of an HTML page, which is returned to the user to describe the problem. The page is sent with a default HTML header; the message is enclosed in simple body tags (<body></body>).

Parameters:

sc - the status code

sm - the status message

public abstract void setStatus(int sc)

Sets the status code for this response. This method is used to set the return status code when there is no error (for example, for the status codes SC_OK or SC_MOVED_TEMPORARILY). If there is an error, the sendError method should be used instead.

Parameters:

sc - the status code

See Also:

sendError

All Packages  Class Hierarchy  This Package  Previous  Next  Index