org.apache.shindig.gadgets.js

Class JsResponse

java.lang.Object

org.apache.shindig.gadgets.js.JsResponse

public class JsResponse
extends Object

An immutable object that contains the response for a JavaScript request. This object is used by JsHandler, JsProcessors, and JsCompiler alike.

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<JsContent>	getAllJsContent() Returns an iterator starting at the beginning of all JS code in the response.
int	getCacheTtlSecs() Returns the cache TTL in seconds for this response.
List<String>	getErrors() Returns a list of any error messages associated with this response.
String	getExterns() Returns a string of generated externs.
int	getStatusCode() Returns the HTTP status code.
boolean	isError() Returns whether the current response code is an error code.
boolean	isProxyCacheable() Returns whether the response can be cached by intermediary proxies.
String	toErrorString() Returns a string of all error messages associated with this response.
String	toJsString() Returns the JavaScript code to serve.

Methods inherited from class java.lang.Object

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

Method Detail

toJsString

public String toJsString()

Returns the JavaScript code to serve.

getAllJsContent

public Iterable<JsContent> getAllJsContent()

Returns an iterator starting at the beginning of all JS code in the response.

getStatusCode

public int getStatusCode()

Returns the HTTP status code.

isError

public boolean isError()

Returns whether the current response code is an error code.

getCacheTtlSecs

public int getCacheTtlSecs()

Returns the cache TTL in seconds for this response. 0 seconds means "no cache"; a value below 0 means "cache forever".

isProxyCacheable

public boolean isProxyCacheable()

Returns whether the response can be cached by intermediary proxies.

getErrors

public List<String> getErrors()

Returns a list of any error messages associated with this response.

toErrorString

public String toErrorString()

Returns a string of all error messages associated with this response.

getExterns

public String getExterns()

Returns a string of generated externs.