org.apache.jackrabbit.webdav

Class WebdavResponseImpl

java.lang.Object

org.apache.jackrabbit.webdav.WebdavResponseImpl

All Implemented Interfaces:

javax.servlet.http.HttpServletResponse, javax.servlet.ServletResponse, DavServletResponse, ObservationDavServletResponse, WebdavResponse

public class WebdavResponseImpl
extends java.lang.Object
implements WebdavResponse

WebdavResponseImpl implements the WebdavResponse interface.

Field Summary

Fields inherited from interface org.apache.jackrabbit.webdav.DavServletResponse

SC_FAILED_DEPENDENCY, SC_INSUFFICIENT_SPACE_ON_RESOURCE, SC_LOCKED, SC_MULTI_STATUS, SC_PROCESSING, SC_UNPROCESSABLE_ENTITY

Fields inherited from interface javax.servlet.http.HttpServletResponse

SC_ACCEPTED, SC_BAD_GATEWAY, SC_BAD_REQUEST, SC_CONFLICT, SC_CONTINUE, SC_CREATED, SC_EXPECTATION_FAILED, SC_FORBIDDEN, SC_FOUND, SC_GATEWAY_TIMEOUT, SC_GONE, SC_HTTP_VERSION_NOT_SUPPORTED, SC_INTERNAL_SERVER_ERROR, SC_LENGTH_REQUIRED, SC_METHOD_NOT_ALLOWED, SC_MOVED_PERMANENTLY, SC_MOVED_TEMPORARILY, SC_MULTIPLE_CHOICES, SC_NO_CONTENT, SC_NON_AUTHORITATIVE_INFORMATION, SC_NOT_ACCEPTABLE, SC_NOT_FOUND, SC_NOT_IMPLEMENTED, SC_NOT_MODIFIED, SC_OK, SC_PARTIAL_CONTENT, SC_PAYMENT_REQUIRED, SC_PRECONDITION_FAILED, SC_PROXY_AUTHENTICATION_REQUIRED, SC_REQUEST_ENTITY_TOO_LARGE, SC_REQUEST_TIMEOUT, SC_REQUEST_URI_TOO_LONG, SC_REQUESTED_RANGE_NOT_SATISFIABLE, SC_RESET_CONTENT, SC_SEE_OTHER, SC_SERVICE_UNAVAILABLE, SC_SWITCHING_PROTOCOLS, SC_TEMPORARY_REDIRECT, SC_UNAUTHORIZED, SC_UNSUPPORTED_MEDIA_TYPE, SC_USE_PROXY

Constructor Summary

Constructors

Constructor and Description
WebdavResponseImpl(javax.servlet.http.HttpServletResponse httpResponse) Create a new WebdavResponse
WebdavResponseImpl(javax.servlet.http.HttpServletResponse httpResponse, boolean noCache) Create a new WebdavResponse

Method Summary

Modifier and Type	Method and Description
void	addCookie(javax.servlet.http.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 name)
java.util.Collection<java.lang.String>	getHeaderNames()
java.util.Collection<java.lang.String>	getHeaders(java.lang.String name)
java.util.Locale	getLocale()
javax.servlet.ServletOutputStream	getOutputStream()
int	getStatus()
java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>>	getTrailerFields()
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)
void	sendError(int i, java.lang.String s)
void	sendMultiStatus(MultiStatus multistatus) Send the multistatus response to the client.
void	sendMultiStatus(MultiStatus multistatus, java.util.List<java.lang.String> acceptableContentCodings) Send the multistatus response to the client.
void	sendPollResponse(EventDiscovery eventDiscovery) Send the response to a successful POLL request.
void	sendRedirect(java.lang.String s)
void	sendRefreshLockResponse(ActiveLock[] locks) Send response body for a lock request that was intended to refresh one or several locks.
void	sendSubscriptionResponse(Subscription subscription) Send the response to a successful SUBSCRIBE request.
void	sendXmlResponse(XmlSerializable serializable, int status) Generic method to return an Xml response body.
void	sendXmlResponse(XmlSerializable serializable, int status, java.util.List<java.lang.String> acceptableContentCodings) Generic method to return an Xml response body.
void	setBufferSize(int i)
void	setCharacterEncoding(java.lang.String charset)
void	setContentLength(int i)
void	setContentLengthLong(long len)
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)
void	setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> supplier)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebdavResponseImpl

public WebdavResponseImpl(javax.servlet.http.HttpServletResponse httpResponse)

Create a new WebdavResponse

Parameters:

httpResponse -

WebdavResponseImpl

public WebdavResponseImpl(javax.servlet.http.HttpServletResponse httpResponse,
                          boolean noCache)

Create a new WebdavResponse

Parameters:

httpResponse -

noCache -

Method Detail

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.

Specified by:

sendError in interface DavServletResponse

Parameters:

exception -

Throws:

java.io.IOException

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

Description copied from interface: DavServletResponse

Send the multistatus response to the client. A multistatus response is returned in response to a successful PROPFIND and PROPPATCH request. In addition multistatus response is required response in case a COPY, MOVE, DELETE, LOCK or PROPPATCH request fails.

Specified by:

sendMultiStatus in interface DavServletResponse

Throws:

java.io.IOException

See Also:

DavServletResponse.SC_MULTI_STATUS

sendMultiStatus

public void sendMultiStatus(MultiStatus multistatus,
                            java.util.List<java.lang.String> acceptableContentCodings)
                     throws java.io.IOException

Description copied from interface: DavServletResponse

Send the multistatus response to the client. A multistatus response is returned in response to a successful PROPFIND and PROPPATCH request. In addition multistatus response is required response in case a COPY, MOVE, DELETE, LOCK or PROPPATCH request fails.

Specified by:

sendMultiStatus in interface DavServletResponse

acceptableContentCodings - content codings accepted by the client

Throws:

java.io.IOException

See Also:

DavServletResponse.SC_MULTI_STATUS

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.

Specified by:

sendRefreshLockResponse in interface DavServletResponse

Parameters:

locks -

Throws:

java.io.IOException

See Also:

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

sendXmlResponse

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

Description copied from interface: DavServletResponse

Generic method to return an Xml response body.

Specified by:

sendXmlResponse in interface DavServletResponse

Parameters:

serializable - object that can be converted to the root Xml element of the document to be sent as response body.

status - Status code to be used with HttpServletResponse.setStatus(int).

Throws:

java.io.IOException

sendXmlResponse

public void sendXmlResponse(XmlSerializable serializable,
                            int status,
                            java.util.List<java.lang.String> acceptableContentCodings)
                     throws java.io.IOException

Description copied from interface: DavServletResponse

Generic method to return an Xml response body.

Specified by:

sendXmlResponse in interface DavServletResponse

Parameters:

serializable - object that can be converted to the root Xml element of the document to be sent as response body.

status - Status code to be used with HttpServletResponse.setStatus(int).

acceptableContentCodings - content codings accepted by the client

Throws:

java.io.IOException

sendSubscriptionResponse

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

Description copied from interface: ObservationDavServletResponse

Send the response to a successful SUBSCRIBE request.

Specified by:

sendSubscriptionResponse in interface ObservationDavServletResponse

Parameters:

subscription -

Throws:

java.io.IOException

See Also:

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

sendPollResponse

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

Description copied from interface: ObservationDavServletResponse

Send the response to a successful POLL request.

Specified by:

sendPollResponse in interface ObservationDavServletResponse

Parameters:

eventDiscovery -

Throws:

java.io.IOException

See Also:

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

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface javax.servlet.http.HttpServletResponse

containsHeader

public boolean containsHeader(java.lang.String s)

Specified by:

containsHeader in interface javax.servlet.http.HttpServletResponse

encodeURL

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

Specified by:

encodeURL in interface javax.servlet.http.HttpServletResponse

encodeRedirectURL

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

Specified by:

encodeRedirectURL in interface javax.servlet.http.HttpServletResponse

encodeUrl

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

Specified by:

encodeUrl in interface javax.servlet.http.HttpServletResponse

encodeRedirectUrl

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

Specified by:

encodeRedirectUrl in interface javax.servlet.http.HttpServletResponse

sendError

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

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

java.io.IOException

sendError

public void sendError(int i)
               throws java.io.IOException

Specified by:

sendError in interface javax.servlet.http.HttpServletResponse

Throws:

java.io.IOException

sendRedirect

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

Specified by:

sendRedirect in interface javax.servlet.http.HttpServletResponse

Throws:

java.io.IOException

setDateHeader

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

Specified by:

setDateHeader in interface javax.servlet.http.HttpServletResponse

addDateHeader

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

Specified by:

addDateHeader in interface javax.servlet.http.HttpServletResponse

setHeader

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

Specified by:

setHeader in interface javax.servlet.http.HttpServletResponse

addHeader

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

Specified by:

addHeader in interface javax.servlet.http.HttpServletResponse

setIntHeader

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

Specified by:

setIntHeader in interface javax.servlet.http.HttpServletResponse

addIntHeader

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

Specified by:

addIntHeader in interface javax.servlet.http.HttpServletResponse

setStatus

public void setStatus(int i)

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

setStatus

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

Specified by:

setStatus in interface javax.servlet.http.HttpServletResponse

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletResponse

getOutputStream

public javax.servlet.ServletOutputStream getOutputStream()
                                                  throws java.io.IOException

Specified by:

getOutputStream in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

getWriter

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

Specified by:

getWriter in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

setContentLength

public void setContentLength(int i)

Specified by:

setContentLength in interface javax.servlet.ServletResponse

setContentType

public void setContentType(java.lang.String s)

Specified by:

setContentType in interface javax.servlet.ServletResponse

setBufferSize

public void setBufferSize(int i)

Specified by:

setBufferSize in interface javax.servlet.ServletResponse

getBufferSize

public int getBufferSize()

Specified by:

getBufferSize in interface javax.servlet.ServletResponse

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Specified by:

flushBuffer in interface javax.servlet.ServletResponse

Throws:

java.io.IOException

resetBuffer

public void resetBuffer()

Specified by:

resetBuffer in interface javax.servlet.ServletResponse

isCommitted

public boolean isCommitted()

Specified by:

isCommitted in interface javax.servlet.ServletResponse

reset

public void reset()

Specified by:

reset in interface javax.servlet.ServletResponse

setLocale

public void setLocale(java.util.Locale locale)

Specified by:

setLocale in interface javax.servlet.ServletResponse

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletResponse

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletResponse

setCharacterEncoding

public void setCharacterEncoding(java.lang.String charset)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletResponse

getStatus

public int getStatus()

Specified by:

getStatus in interface javax.servlet.http.HttpServletResponse

getHeader

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

Specified by:

getHeader in interface javax.servlet.http.HttpServletResponse

getHeaders

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

Specified by:

getHeaders in interface javax.servlet.http.HttpServletResponse

getHeaderNames

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

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletResponse

setContentLengthLong

public void setContentLengthLong(long len)

Specified by:

setContentLengthLong in interface javax.servlet.ServletResponse

setTrailerFields

public void setTrailerFields(java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> supplier)

Specified by:

setTrailerFields in interface javax.servlet.http.HttpServletResponse

Specified by:

setTrailerFields in interface WebdavResponse

getTrailerFields

public java.util.function.Supplier<java.util.Map<java.lang.String,java.lang.String>> getTrailerFields()

Specified by:

getTrailerFields in interface javax.servlet.http.HttpServletResponse

Specified by:

getTrailerFields in interface WebdavResponse