com.aspc.webdav

Class STDavResponse

java.lang.Object

com.aspc.webdav.STDavResponse

public class STDavResponse
extends java.lang.Object

Web dav
THREAD MODE: SINGLE-THREADED

Since:

3 Oct 2008

Author:

Lahav

Constructor Summary

Constructors

Constructor and Description
STDavResponse(STDavRequest webdavRequest, HttpServletResponse httpResponse, boolean noCache) Create a new WebdavResponse

Method Summary

Modifier and Type	Method and Description
void	_sendLockResponse(ActiveLock lock) Send response body for a lock request intended to create a new lock.
void	addCookie(Cookie cookie)
void	addDateHeader(java.lang.String s, long l)
void	addHeader(java.lang.String s, java.lang.String s1)
void	addIntHeader(java.lang.String s, int i)
boolean	containsHeader(java.lang.String s)
java.lang.String	encodeRedirectUrl(java.lang.String s)
java.lang.String	encodeRedirectURL(java.lang.String s)
java.lang.String	encodeUrl(java.lang.String s)
java.lang.String	encodeURL(java.lang.String s)
void	flushBuffer()
int	getBufferSize()
java.lang.String	getCharacterEncoding()
java.lang.String	getContentType()
java.lang.String	getHeader(java.lang.String h)
java.util.Collection<java.lang.String>	getHeaderNames()
java.util.Collection<java.lang.String>	getHeaders(java.lang.String h)
java.util.Locale	getLocale()
ServletOutputStream	getOutputStream()
int	getStatus()
java.io.PrintWriter	getWriter()
boolean	isCommitted()
void	reset()
void	resetBuffer()
void	sendError(DavException exception) If the specifid exception provides an error condition an Xml response body is sent providing more detailed information about the error.
void	sendError(int i, java.lang.String s)
void	sendMultiStatus(MultiStatus multistatus) Send a multistatus response.
void	sendPollResponse(EventDiscovery eventDiscovery)
void	sendRedirect(java.lang.String url)
void	sendRefreshLockResponse(ActiveLock[] locks) Send response body for a lock request that was intended to refresh one or several locks.
void	sendSubscriptionResponse(Subscription subscription)
void	sendXmlResponse(XmlSerializable serializable, int status) send the xml
void	setBufferSize(int i)
void	setCharacterEncoding(java.lang.String env)
void	setContentLength(int i)
void	setContentLengthLong(long contentLength)
void	setContentType(java.lang.String s)
void	setDateHeader(java.lang.String s, long l)
void	setHeader(java.lang.String s, java.lang.String s1)
void	setIntHeader(java.lang.String s, int i)
void	setLocale(java.util.Locale locale)
void	setStatus(int i)
void	setStatus(int i, java.lang.String s)

Methods inherited from class java.lang.Object

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

Constructor Detail

STDavResponse

public STDavResponse(STDavRequest webdavRequest,
                     HttpServletResponse httpResponse,
                     boolean noCache)

Create a new WebdavResponse

Parameters:

httpResponse - the response

webdavRequest - the request

noCache - no cache

Method Detail

sendXmlResponse

public void sendXmlResponse(XmlSerializable serializable,
                            int status)
                     throws java.io.IOException

send the xml

Parameters:

serializable - the xml

status - the status

Throws:

java.io.IOException - a problem

setCharacterEncoding

public void setCharacterEncoding(java.lang.String env)

Parameters:

env - ignored

getContentType

public java.lang.String getContentType()

Returns:

null

sendError

public void sendError(DavException exception)
               throws java.io.IOException

If the specifid exception provides an error condition an Xml response body is sent providing more detailed information about the error. Otherwise only the error code and status phrase is sent back.

Parameters:

exception - the exception

Throws:

java.io.IOException - a problem

See Also:

DavServletResponse#sendError(org.apache.jackrabbit.webdav.DavException), sendError(int, String), sendXmlResponse(XmlSerializable, int)

sendMultiStatus

public void sendMultiStatus(MultiStatus multistatus)
                     throws java.io.IOException

Send a multistatus response.

Parameters:

multistatus - the multi status

Throws:

java.io.IOException - a problem

See Also:

DavServletResponse#sendMultiStatus(org.apache.jackrabbit.webdav.MultiStatus)

_sendLockResponse

public void _sendLockResponse(ActiveLock lock)
                       throws java.io.IOException

Send response body for a lock request intended to create a new lock.

Parameters:

lock - the lock

Throws:

java.io.IOException - a problem

See Also:

DavServletResponse#sendLockResponse(org.apache.jackrabbit.webdav.lock.ActiveLock)

sendRefreshLockResponse

public void sendRefreshLockResponse(ActiveLock[] locks)
                             throws java.io.IOException

Send response body for a lock request that was intended to refresh one or several locks.

Parameters:

locks - the locks

Throws:

java.io.IOException - a problem

See Also:

DavServletResponse#sendRefreshLockResponse(org.apache.jackrabbit.webdav.lock.ActiveLock[])

sendSubscriptionResponse

public void sendSubscriptionResponse(Subscription subscription)
                              throws java.io.IOException

Parameters:

subscription - the subscription

Throws:

java.io.IOException - a problem

See Also:

org.apache.jackrabbit.webdav.observation.ObservationDavServletResponse#sendSubscriptionResponse(org.apache.jackrabbit.webdav.observation.Subscription)

sendPollResponse

public void sendPollResponse(EventDiscovery eventDiscovery)
                      throws java.io.IOException

Parameters:

eventDiscovery - the event

Throws:

java.io.IOException - a problem

See Also:

org.apache.jackrabbit.webdav.observation.ObservationDavServletResponse#sendPollResponse(org.apache.jackrabbit.webdav.observation.EventDiscovery)

addCookie

public void addCookie(Cookie cookie)

Parameters:

cookie -

containsHeader

public boolean containsHeader(java.lang.String s)

Parameters:

s -

Returns:

the value

encodeURL

public java.lang.String encodeURL(java.lang.String s)

Parameters:

s -

Returns:

the value

encodeRedirectURL

public java.lang.String encodeRedirectURL(java.lang.String s)

Parameters:

s -

Returns:

the value

encodeUrl

public java.lang.String encodeUrl(java.lang.String s)

Parameters:

s -

Returns:

the value

encodeRedirectUrl

public java.lang.String encodeRedirectUrl(java.lang.String s)

Parameters:

s -

Returns:

the value

sendError

public void sendError(int i,
                      java.lang.String s)
               throws java.io.IOException

Parameters:

i -

s -

Throws:

java.io.IOException - if an IO exception occurs.

sendRedirect

public void sendRedirect(java.lang.String url)
                  throws java.io.IOException

Parameters:

url -

Throws:

java.io.IOException - if an IO exception occurs.

setDateHeader

public void setDateHeader(java.lang.String s,
                          long l)

Parameters:

s -

l -

addDateHeader

public void addDateHeader(java.lang.String s,
                          long l)

Parameters:

s -

l -

setHeader

public void setHeader(java.lang.String s,
                      java.lang.String s1)

Parameters:

s -

s1 -

addHeader

public final void addHeader(java.lang.String s,
                            java.lang.String s1)

Parameters:

s -

s1 -

setIntHeader

public void setIntHeader(java.lang.String s,
                         int i)

Parameters:

s -

i -

addIntHeader

public void addIntHeader(java.lang.String s,
                         int i)

Parameters:

s -

i -

setStatus

public void setStatus(int i)

Parameters:

i -

setStatus

public void setStatus(int i,
                      java.lang.String s)

Parameters:

i -

s -

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Returns:

the value

getOutputStream

public ServletOutputStream getOutputStream()
                                    throws java.io.IOException

Returns:

the value

Throws:

java.io.IOException - if an IO exception occurs.

getWriter

public java.io.PrintWriter getWriter()
                              throws java.io.IOException

Returns:

the value

Throws:

java.io.IOException - if an IO exception occurs.

setContentLength

public void setContentLength(int i)

Parameters:

i -

setContentLengthLong

public void setContentLengthLong(long contentLength)

setContentType

public void setContentType(java.lang.String s)

Parameters:

s -

setBufferSize

public void setBufferSize(int i)

Parameters:

i -

getBufferSize

public int getBufferSize()

Returns:

the value

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Throws:

java.io.IOException - if an IO exception occurs.

resetBuffer

public void resetBuffer()

isCommitted

public boolean isCommitted()

Returns:

the value

reset

public void reset()

setLocale

public void setLocale(java.util.Locale locale)

Parameters:

locale -

getLocale

public java.util.Locale getLocale()

Returns:

the value

getHeaders

public java.util.Collection<java.lang.String> getHeaders(java.lang.String h)

getHeader

public java.lang.String getHeader(java.lang.String h)

getStatus

public int getStatus()

getHeaderNames

public java.util.Collection<java.lang.String> getHeaderNames()