Package org.apache.jackrabbit.webdav
Class WebdavResponseImpl
java.lang.Object
org.apache.jackrabbit.webdav.WebdavResponseImpl
- All Implemented Interfaces:
jakarta.servlet.http.HttpServletResponse
,jakarta.servlet.ServletResponse
,DavServletResponse
,org.apache.jackrabbit.webdav.observation.ObservationDavServletResponse
,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 jakarta.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_MISDIRECTED_REQUEST, 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_PERMANENT_REDIRECT, 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_UNPROCESSABLE_CONTENT, SC_UNSUPPORTED_MEDIA_TYPE, SC_UPGRADE_REQUIRED, SC_USE_PROXY
-
Constructor Summary
ConstructorsConstructorDescriptionWebdavResponseImpl
(jakarta.servlet.http.HttpServletResponse httpResponse) Create a newWebdavResponse
WebdavResponseImpl
(jakarta.servlet.http.HttpServletResponse httpResponse, boolean noCache) Create a newWebdavResponse
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCookie
(jakarta.servlet.http.Cookie cookie) void
addDateHeader
(String s, long l) void
void
addIntHeader
(String s, int i) boolean
void
int
getHeaders
(String name) jakarta.servlet.ServletOutputStream
int
boolean
void
reset()
void
void
sendError
(int i) void
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
sendMultiStatus
(MultiStatus multistatus) Send the multistatus response to the client.void
sendMultiStatus
(MultiStatus multistatus, List<String> acceptableContentCodings) Send the multistatus response to the client.void
sendPollResponse
(org.apache.jackrabbit.webdav.observation.EventDiscovery eventDiscovery) Send the response to a successful POLL request.void
void
sendRedirect
(String arg0, int arg1, boolean arg2) void
sendRefreshLockResponse
(org.apache.jackrabbit.webdav.lock.ActiveLock[] locks) Send response body for a lock request that was intended to refresh one or several locks.void
sendSubscriptionResponse
(org.apache.jackrabbit.webdav.observation.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, List<String> acceptableContentCodings) Generic method to return an Xml response body.void
setBufferSize
(int i) void
setCharacterEncoding
(String charset) void
setContentLength
(int i) void
setContentLengthLong
(long len) void
void
setDateHeader
(String s, long l) void
void
setIntHeader
(String s, int i) void
void
setStatus
(int i) void
setTrailerFields
(Supplier<Map<String, String>> supplier) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jakarta.servlet.http.HttpServletResponse
sendRedirect, sendRedirect
Methods inherited from interface jakarta.servlet.ServletResponse
setCharacterEncoding
-
Constructor Details
-
WebdavResponseImpl
public WebdavResponseImpl(jakarta.servlet.http.HttpServletResponse httpResponse) Create a newWebdavResponse
- Parameters:
httpResponse
-
-
WebdavResponseImpl
public WebdavResponseImpl(jakarta.servlet.http.HttpServletResponse httpResponse, boolean noCache) Create a newWebdavResponse
- Parameters:
httpResponse
-noCache
-
-
-
Method Details
-
sendError
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 interfaceDavServletResponse
- Parameters:
exception
-- Throws:
IOException
- See Also:
-
sendMultiStatus
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 interfaceDavServletResponse
- Throws:
IOException
- See Also:
-
sendMultiStatus
public void sendMultiStatus(MultiStatus multistatus, List<String> acceptableContentCodings) throws 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 interfaceDavServletResponse
acceptableContentCodings
- content codings accepted by the client- Throws:
IOException
- See Also:
-
sendRefreshLockResponse
public void sendRefreshLockResponse(org.apache.jackrabbit.webdav.lock.ActiveLock[] locks) throws IOException Send response body for a lock request that was intended to refresh one or several locks.- Specified by:
sendRefreshLockResponse
in interfaceDavServletResponse
- Parameters:
locks
-- Throws:
IOException
- See Also:
-
sendXmlResponse
Description copied from interface:DavServletResponse
Generic method to return an Xml response body.- Specified by:
sendXmlResponse
in interfaceDavServletResponse
- 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 withHttpServletResponse.setStatus(int)
.- Throws:
IOException
-
sendXmlResponse
public void sendXmlResponse(XmlSerializable serializable, int status, List<String> acceptableContentCodings) throws IOException Description copied from interface:DavServletResponse
Generic method to return an Xml response body.- Specified by:
sendXmlResponse
in interfaceDavServletResponse
- 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 withHttpServletResponse.setStatus(int)
.acceptableContentCodings
- content codings accepted by the client- Throws:
IOException
-
sendSubscriptionResponse
public void sendSubscriptionResponse(org.apache.jackrabbit.webdav.observation.Subscription subscription) throws IOException Description copied from interface:org.apache.jackrabbit.webdav.observation.ObservationDavServletResponse
Send the response to a successful SUBSCRIBE request.- Specified by:
sendSubscriptionResponse
in interfaceorg.apache.jackrabbit.webdav.observation.ObservationDavServletResponse
- Parameters:
subscription
-- Throws:
IOException
- See Also:
-
ObservationDavServletResponse.sendSubscriptionResponse(org.apache.jackrabbit.webdav.observation.Subscription)
-
sendPollResponse
public void sendPollResponse(org.apache.jackrabbit.webdav.observation.EventDiscovery eventDiscovery) throws IOException Description copied from interface:org.apache.jackrabbit.webdav.observation.ObservationDavServletResponse
Send the response to a successful POLL request.- Specified by:
sendPollResponse
in interfaceorg.apache.jackrabbit.webdav.observation.ObservationDavServletResponse
- Parameters:
eventDiscovery
-- Throws:
IOException
- See Also:
-
ObservationDavServletResponse.sendPollResponse(org.apache.jackrabbit.webdav.observation.EventDiscovery)
-
addCookie
public void addCookie(jakarta.servlet.http.Cookie cookie) - Specified by:
addCookie
in interfacejakarta.servlet.http.HttpServletResponse
-
containsHeader
- Specified by:
containsHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
encodeURL
- Specified by:
encodeURL
in interfacejakarta.servlet.http.HttpServletResponse
-
encodeRedirectURL
- Specified by:
encodeRedirectURL
in interfacejakarta.servlet.http.HttpServletResponse
-
sendError
- Specified by:
sendError
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-
sendError
- Specified by:
sendError
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-
sendRedirect
- Specified by:
sendRedirect
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-
setDateHeader
- Specified by:
setDateHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
addDateHeader
- Specified by:
addDateHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
setHeader
- Specified by:
setHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
addHeader
- Specified by:
addHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
setIntHeader
- Specified by:
setIntHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
addIntHeader
- Specified by:
addIntHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
setStatus
public void setStatus(int i) - Specified by:
setStatus
in interfacejakarta.servlet.http.HttpServletResponse
-
getCharacterEncoding
- Specified by:
getCharacterEncoding
in interfacejakarta.servlet.ServletResponse
-
getOutputStream
- Specified by:
getOutputStream
in interfacejakarta.servlet.ServletResponse
- Throws:
IOException
-
getWriter
- Specified by:
getWriter
in interfacejakarta.servlet.ServletResponse
- Throws:
IOException
-
setContentLength
public void setContentLength(int i) - Specified by:
setContentLength
in interfacejakarta.servlet.ServletResponse
-
setContentType
- Specified by:
setContentType
in interfacejakarta.servlet.ServletResponse
-
setBufferSize
public void setBufferSize(int i) - Specified by:
setBufferSize
in interfacejakarta.servlet.ServletResponse
-
getBufferSize
public int getBufferSize()- Specified by:
getBufferSize
in interfacejakarta.servlet.ServletResponse
-
flushBuffer
- Specified by:
flushBuffer
in interfacejakarta.servlet.ServletResponse
- Throws:
IOException
-
resetBuffer
public void resetBuffer()- Specified by:
resetBuffer
in interfacejakarta.servlet.ServletResponse
-
isCommitted
public boolean isCommitted()- Specified by:
isCommitted
in interfacejakarta.servlet.ServletResponse
-
reset
public void reset()- Specified by:
reset
in interfacejakarta.servlet.ServletResponse
-
setLocale
- Specified by:
setLocale
in interfacejakarta.servlet.ServletResponse
-
getLocale
- Specified by:
getLocale
in interfacejakarta.servlet.ServletResponse
-
getContentType
- Specified by:
getContentType
in interfacejakarta.servlet.ServletResponse
-
setCharacterEncoding
- Specified by:
setCharacterEncoding
in interfacejakarta.servlet.ServletResponse
-
getStatus
public int getStatus()- Specified by:
getStatus
in interfacejakarta.servlet.http.HttpServletResponse
-
getHeader
- Specified by:
getHeader
in interfacejakarta.servlet.http.HttpServletResponse
-
getHeaders
- Specified by:
getHeaders
in interfacejakarta.servlet.http.HttpServletResponse
-
getHeaderNames
- Specified by:
getHeaderNames
in interfacejakarta.servlet.http.HttpServletResponse
-
setContentLengthLong
public void setContentLengthLong(long len) - Specified by:
setContentLengthLong
in interfacejakarta.servlet.ServletResponse
-
setTrailerFields
- Specified by:
setTrailerFields
in interfacejakarta.servlet.http.HttpServletResponse
- Specified by:
setTrailerFields
in interfaceWebdavResponse
-
getTrailerFields
- Specified by:
getTrailerFields
in interfacejakarta.servlet.http.HttpServletResponse
- Specified by:
getTrailerFields
in interfaceWebdavResponse
-
sendRedirect
- Specified by:
sendRedirect
in interfacejakarta.servlet.http.HttpServletResponse
- Throws:
IOException
-