HttpResponse - Reference Documentation
Class implementing the response passed to a scripting servlet.
Instances of this class wrap the HttpServletResponse from the Servlet API and allow scripts easy access to properties of an outgoing HTTP response.
Instances of this class can not be created directly, but are passed as argument to the handleRequest() method.
Index of Methods
- HttpResponse() constructor
- addHeaderField()
- setContentType()
- setCharacterEncoding()
- setContentLength()
- setStatus()
- write()
- print()
- println()
Constants
| Type | Name | Description |
|---|---|---|
| Number | SC_CONTINUE | Status code (100) indicating the client can continue. |
| Number | SC_SWITCHING_PROTOCOLS | Status code (101) indicating the server is switching protocols according to Upgrade header. |
| Number | SC_OK | Status code (200) indicating the request succeeded normally. |
| Number | SC_CREATED | Status code (201) indicating the request succeeded and created a new resource on the server. |
| Number | SC_ACCEPTED | Status code (202) indicating that a request was accepted for processing, but was not completed. |
| Number | SC_NON_AUTHORITATIVE_INFORMATION | Status code (203) indicating that the meta information presented by the client did not originate from the server. |
| Number | SC_NO_CONTENT | Status code (204) indicating that the request succeeded but that there was no new information to return. |
| Number | SC_RESET_CONTENT | Status code (205) indicating that the agent SHOULD reset the document view which caused the request to be sent. |
| Number | SC_PARTIAL_CONTENT | Status code (206) indicating that the server has fulfilled the partial GET request for the resource. |
| Number | 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. |
| Number | 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. |
| Number | SC_FOUND | Status code (302) indicating that the resource reside temporarily under a different URI. |
| Number | 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. |
| Number | SC_SEE_OTHER | Status code (303) indicating that the response to the request can be found under a different URI. |
| Number | SC_NOT_MODIFIED | Status code (304) indicating that a conditional GET operation found that the resource was available and not modified. |
| Number | SC_USE_PROXY | Status code (305) indicating that the requested resource MUST be accessed through the proxy given by the Location field. |
| Number | SC_TEMPORARY_REDIRECT | Status code (307) indicating that the requested resource resides temporarily under a different URI. |
| Number | SC_BAD_REQUEST | Status code (400) indicating the request sent by the client was syntactically incorrect. |
| Number | SC_UNAUTHORIZED | Status code (401) indicating that the request requires HTTP authentication. |
| Number | SC_PAYMENT_REQUIRED | Status code (402) reserved for future use. |
| Number | SC_FORBIDDEN | Status code (403) indicating the server understood the request but refused to fulfill it. |
| Number | SC_NOT_FOUND | Status code (404) indicating that the requested resource is not available. |
| Number | 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. |
| Number | 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. |
| Number | SC_PROXY_AUTHENTICATION_REQUIRED | Status code (407) indicating that the client MUST first authenticate itself with the proxy. |
| Number | 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. |
| Number | SC_CONFLICT | Status code (409) indicating that the request could not be completed due to a conflict with the current state of the resource. |
| Number | SC_GONE | Status code (410) indicating that the resource is no longer available at the server and no forwarding address is known. |
| Number | SC_LENGTH_REQUIRED | Status code (411) indicating that the request cannot be handled without a defined Content-Length. |
| Number | 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. |
| Number | 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. |
| Number | 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. |
| Number | 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. |
| Number | SC_REQUESTED_RANGE_NOT_SATISFIABLE | Status code (416) indicating that the server cannot serve the requested byte range. |
| Number | SC_EXPECTATION_FAILED | Status code (417) indicating that the server could not meet the expectation given in the Expect request header. |
| Number | SC_INTERNAL_SERVER_ERROR | Status code (500) indicating an error inside the HTTP server which prevented it from fulfilling the request. |
| Number | SC_NOT_IMPLEMENTED | Status code (501) indicating the HTTP server does not support the functionality needed to fulfill the request. |
| Number | 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. |
| Number | SC_SERVICE_UNAVAILABLE | Status code (503) indicating that the HTTP server is temporarily overloaded, and unable to handle the request. |
| Number | 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. |
| Number | 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. |
Properties
| Type | Name | Description |
|---|---|---|
| HttpServletResponse | nativeResponse | The native HttpServletResponse object |
addHeaderField()
Prototype
void addHeaderField(String key, String value)
void addHeader(String key, String value) (Deprecated)
Description
Add a http header field to the response.
Arguments
| Type | Name | Description |
|---|---|---|
String
|
key | The header field name |
String
|
value | The header field value |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
// See HTTPResponse.getHeaderField for an example
setContentType()
Prototype
void setContentType(String contentType)
Description
Set the content type for the response.
See also javax.servlet.http.HttpServletResponse.setContentType.
Arguments
| Type | Name | Description |
|---|---|---|
String
|
contentType | The content type |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
setCharacterEncoding()
Prototype
void setCharacterEncoding(String encoding)
Description
Set the character encoding for the response.
See also javax.servlet.http.HttpServletResponse.setCharacterEncoding.
Arguments
| Type | Name | Description |
|---|---|---|
String
|
encoding | The desired character encoding for the response |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
setContentLength()
Prototype
void setContentLength(Number length)
Description
Set the content length for the response entity.
See also javax.servlet.http.HttpServletResponse.setContentLength.
Arguments
| Type | Name | Description |
|---|---|---|
Number
|
length | The number of bytes in the response's entity |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
setStatus()
Prototype
void setStatus(Number code)
Description
Set the status code for the response entity.
See also javax.servlet.http.HttpServletResponse.setStatus.
Arguments
| Type | Name | Description |
|---|---|---|
Number
|
code | The status code, e.g. any of the SC_ constants defined above |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
write()
Prototype
void write(ByteString data)
Description
Write binary data as part of the response.
Arguments
| Type | Name | Description |
|---|---|---|
ByteString
|
data | Binary data to be written to the response stream |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
print()
Prototype
void print(String data)
Description
Write String data as part of the response.
Arguments
| Type | Name | Description |
|---|---|---|
String
|
data | Text data to be written to the response stream |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
println()
Prototype
void println(String data)
Description
Write String data followed by CR/LF as part of the response.
Arguments
| Type | Name | Description |
|---|---|---|
String
|
data | Text data to be written to the response stream |
Return
|
Exceptions
| Name | Value | Description |
|---|---|---|
| GPError | GPError.ARGUMENTS_MISSING | Too few arguments in call |
| GPError | GPError.INVALID_ARGUMENTS | Too many arguments in call |
| GPError | GPError.INVALID_TYPE | Type of argument is invalid for call |
Example
© Copyright 2003 - 2020 CardContact Systems GmbH , Minden, Germany