org.apache.xindice.webadmin.webdav
Class DAVResponse

java.lang.Object
  org.apache.xindice.webadmin.webdav.DAVResponse

public class DAVResponse

extends Object

This is a wrapper class that provides additional DAV-specific functionality

Version:

$Revision: 541515 $, $Date: 2007-05-24 22:45:06 -0400 (Thu, 24 May 2007) $

Field Summary

static String	DAV_NS
protected javax.servlet.ServletOutputStream	out

Constructor Summary

DAVResponse(javax.servlet.http.HttpServletResponse response)
Creates new instance of DAVRequest.

Method Summary

void	addDateHeader(String header, long date) Wrapper method, adds date header to HTTP response.
void	addHeader(String header, String value) Wrapper method, adds header to HTTP response.
void	closeMultistatusResponse() For multi-status responses, close the response document.
javax.servlet.ServletOutputStream	getOutputStream() Wrapper method, returns HTTP response output stream
String	getProtocol() Returns protocol/version.
void	sendMultiStatusResponse(PartialResponse res) For multi-status responses, send a partial response.
void	sendRedirect(String redirect) Wrapper method, sends redirect
void	setContentLength(int contentLength) Wrapper method, sets HTTP response content length
void	setContentType(String mimeType) Wrapper method, sets HTTP response content type
void	setProtocol(String protocol) Sets protocol/version string that is used for multi status responses.
void	setStatus(int status) Wrapper method, sets HTTP response status.

Methods inherited from class java.lang.Object

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

Field Detail

DAV_NS

public static final String DAV_NS

See Also:

Constant Field Values

out

protected final javax.servlet.ServletOutputStream out

Constructor Detail

DAVResponse

public DAVResponse(javax.servlet.http.HttpServletResponse response)
            throws IOException

Creates new instance of DAVRequest.

Parameters:

response - HttpServletResponse

Method Detail

sendMultiStatusResponse

public void sendMultiStatusResponse(PartialResponse res)
                             throws IOException

For multi-status responses, send a partial response. This method resets HTTP response status to 207 (Multi-Status).

Parameters:

res - partial response information

Throws:

IOException - Servlet IOException

closeMultistatusResponse

public void closeMultistatusResponse()
                              throws IOException

For multi-status responses, close the response document. Method does not affect not multi-status responses. HTTP response status to 207 (Multi-Status).

Throws:

IOException - Servlet IOException

setStatus

public void setStatus(int status)

Wrapper method, sets HTTP response status.

Parameters:

status -

addHeader

public void addHeader(String header,
                      String value)

Wrapper method, adds header to HTTP response.

Parameters:

header - Header name

value - Header value

addDateHeader

public void addDateHeader(String header,
                          long date)

Wrapper method, adds date header to HTTP response.

Parameters:

header - Header name

date - Header value

setContentType

public void setContentType(String mimeType)

Wrapper method, sets HTTP response content type

Parameters:

mimeType -

setContentLength

public void setContentLength(int contentLength)

Wrapper method, sets HTTP response content length

Parameters:

contentLength -

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws IOException

Wrapper method, returns HTTP response output stream

Returns:

Servlet output stream

Throws:

IOException

sendRedirect

public void sendRedirect(String redirect)
                  throws IOException

Wrapper method, sends redirect

Parameters:

redirect -

Throws:

IOException

setProtocol

public void setProtocol(String protocol)

Sets protocol/version string that is used for multi status responses.

Parameters:

protocol - Protocol name and version (e.g. HTTP/1.1)

getProtocol

public String getProtocol()

Returns protocol/version.

Returns:

Protocol name and version (e.g. HTTP/1.1)