File	Doc	Category	Size	Date	Package
GDataResponse.java	API Doc	Apache Lucene 2.1.0	16455	Wed Feb 14 10:46:06 GMT 2007	org.apache.lucene.gdata.server

GDataResponse

• java.lang.Object

Fields Summary
public static final int	BAD_REQUEST Response code bad request
public static final int	CONFLICT Response code version conflict
public static final int	FORBIDDEN Response code forbidden access
public static final int	SERVER_ERROR Response code internal server error
public static final int	NOT_FOUND Response code not found
public static final int	NOT_MODIFIED Response code not modified since
public static final int	CREATED Response code created
public static final int	UNAUTHORIZED Response code unauthorized access
static final Log	LOG
private int	error
private boolean	isError
private String	encoding
private org.apache.lucene.gdata.server.GDataRequest.OutputFormat	outputFormat
private final HttpServletResponse	response
protected static final String	XMLMIME_ATOM
protected static final String	XMLMIME_RSS
private static final String	HEADER_LASTMODIFIED

Constructors Summary
public GDataResponse(HttpServletResponse response) Creates a new GDataResponse param response - The underlying {@link HttpServletResponse} if (response == null) throw new IllegalArgumentException("response must not be null"); this.response = response;

Methods Summary
public java.lang.String	getEncoding() This encoding will be used to encode the xml representation of feed or entry written to the {@link HttpServletResponse} output stream. return - the entry / feed encoding return this.encoding;
public org.apache.lucene.gdata.server.GDataRequest.OutputFormat	getOutputFormat() return - the response {@link org.apache.lucene.gdata.server.GDataRequest.OutputFormat} return this.outputFormat;
public java.io.Writer	getWriter() return - the {@link HttpServletResponse} writer throws IOException - If an I/O exception occurs return this.response.getWriter();
public void	sendError() This method sends the specified error to the user if set throws IOException - if an I/O Exception occurs if (this.isError) this.response.sendError(this.error);
public void	sendResponse(com.google.gdata.data.BaseFeed feed, org.apache.lucene.gdata.server.registry.ProvidedService service) Sends a response for a get e.g. query request. This method must not invoked in a case of an error performing the requested action. param feed - the feed to respond to the client param service - the service to render the feed throws IOException - if an I/O exception occurs, often caused by an already closed Writer or OutputStream if (feed == null) throw new IllegalArgumentException("feed must not be null"); if (service == null) throw new IllegalArgumentException( "provided service must not be null"); DateTime time = feed.getUpdated(); if (time != null) setLastModifiedHeader(time.getValue()); FormatWriter writer = FormatWriter.getFormatWriter(this,service); writer.generateOutputFormat(feed,this.response);
public void	sendResponse(com.google.gdata.data.BaseEntry entry, org.apache.lucene.gdata.server.registry.ProvidedService service) Sends a response for an update, insert or delete request. This method must not invoked in a case of an error performing the requested action. If the specified response format is ATOM the default namespace will be set to ATOM. param entry - the modified / created entry to send param service - the service to render the feed throws IOException - if an I/O exception occurs, often caused by an already closed Writer or OutputStream if (entry == null) throw new IllegalArgumentException("entry must not be null"); if (service == null) throw new IllegalArgumentException( "service must not be null"); DateTime time = entry.getUpdated(); if (time != null) setLastModifiedHeader(time.getValue()); FormatWriter writer = FormatWriter.getFormatWriter(this,service); writer.generateOutputFormat(entry,this.response);
public void	setEncoding(java.lang.String encoding) This encoding will be used to encode the xml representation of feed or entry written to the {@link HttpServletResponse} output stream. UTF-8 ISO-8859-1 param encoding - string represents the encoding this.encoding = encoding;
public void	setError(int errorCode) Sets an error code to this FeedResponse. param errorCode - {@link HttpServletResponse} error code this.isError = true; this.error = errorCode;
protected void	setLastModifiedHeader(long lastModified) String lastMod = DateFormater.formatDate(new Date(lastModified), DateFormater.HTTP_HEADER_DATE_FORMAT); this.response.setHeader(HEADER_LASTMODIFIED, lastMod);
public void	setOutputFormat(org.apache.lucene.gdata.server.GDataRequest.OutputFormat outputFormat) param outputFormat - the response {@link org.apache.lucene.gdata.server.GDataRequest.OutputFormat} this.outputFormat = outputFormat;
public void	setResponseCode(int responseCode) Sets the status of the underlying response see HttpServletResponse param responseCode - the status of the response this.response.setStatus(responseCode);
public void	setStatus(int status) see HttpServletResponse#setStatus(int) param status - the request status code this.response.setStatus(status);
public java.lang.String	toString() see Object#toString() StringBuilder builder = new StringBuilder(" GDataResponse: "); builder.append("Error: ").append(this.error); builder.append(" outputFormat: ").append(getOutputFormat()); builder.append(" encoding: ").append(this.encoding); return builder.toString();