votorola.a.web.wap

Class Responding

java.lang.Object

Responding

All Implemented Interfaces:

Requesting, ResponseConfiguration

@ThreadRestricted(value="Call constructor")
public final class Responding
extends Object
implements Requesting, ResponseConfiguration

A context for responding to one or more calls.

Constructor Summary

Constructors

Constructor and Description
Responding(WAP _wap, HttpServletRequest _request, HttpServletResponse _response) Constructs a Responding.

Method Summary

Methods

Modifier and Type	Method and Description
void	headMustRevalidate() Instructs the client to validate the response for every request, such that it never uses a stale response without first asking the user's permission.
void	headNoCache() Makes the response non-cacheable by the client.
Writer	outBuf() The writer for the response.
com.google.gson.stream.JsonWriter	outJSON() A JSON writer based on outBuf.
String	outJSONIndent() The indentation unit for the JSON writer (e.g. 3 or 4 spaces), or an empty string "" if no indentation is required.
HttpServletRequest	request() The HTTP request from the client.
(package private) void	respond() Responds to all calls.
HttpServletResponse	response() The HTTP response to the client.
WAP	wap() The servlet handling the request.
boolean	wPretty() Whether it was requested that the response be human readable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Responding

Responding(WAP _wap,
          HttpServletRequest _request,
          HttpServletResponse _response)
     throws HTTPRequestException

Constructs a Responding.

Throws:

HTTPRequestException

See Also:

wap(), request(), response()

Method Detail

outBuf

@Warning(value="flush outJSON")
public Writer outBuf()

The writer for the response. The bulk of the response is likely to be written indirectly through the tributary buffer outJSON. In any case, be sure to flush outJSON before writing directly to outBuf.

outJSON

public com.google.gson.stream.JsonWriter outJSON()

A JSON writer based on outBuf. Be sure to bracket the response of each particular call in its assigned prefix, as shown here:

   res.outJSON().name( prefix() ).beginObject();
   // output your response here
   res.outJSON().endObject();

outJSONIndent

public String outJSONIndent()

The indentation unit for the JSON writer (e.g. 3 or 4 spaces), or an empty string "" if no indentation is required.

respond

void respond()
       throws IOException

Responds to all calls.

Throws:

IOException

response

public HttpServletResponse response()

The HTTP response to the client.

request

public HttpServletRequest request()

Description copied from interface: Requesting

The HTTP request from the client.

Specified by:

request in interface Requesting

wap

public WAP wap()

Description copied from interface: Requesting

The servlet handling the request.

Specified by:

wap in interface Requesting

wPretty

public boolean wPretty()

Description copied from interface: Requesting

Whether it was requested that the response be human readable.

Specified by:

wPretty in interface Requesting

headMustRevalidate

public void headMustRevalidate()

Description copied from interface: ResponseConfiguration

Instructs the client to validate the response for every request, such that it never uses a stale response without first asking the user's permission. Ensures that Cache-Control must-revalidate is added to the headers.

Specified by:

headMustRevalidate in interface ResponseConfiguration

headNoCache

public void headNoCache()

Description copied from interface: ResponseConfiguration

Makes the response non-cacheable by the client. Ensures that Cache-Control no-cache (HTTP 1.1) and Pragma no-cache (HTTP 1.0) are added to the headers. Also ensures that Cache-Control no-store is added for the sake of clients (Firefox 9) that disobey no-cache.

These nevertheless fail with Chrome 18. Consider adding a nonce to the client request as a fallback.

Specified by:

headNoCache in interface ResponseConfiguration