org.apache.jackrabbit.webdav.transaction

Interface TransactionDavServletRequest

All Superinterfaces:

DavServletRequest, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

All Known Subinterfaces:

WebdavRequest

All Known Implementing Classes:

WebdavRequestImpl

public interface TransactionDavServletRequest
extends DavServletRequest

TransactionDavServletRequest provides extensions to the DavServletRequest interface used for dealing with transaction lock requests.

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Method Summary

Modifier and Type	Method and Description
String	getTransactionId() Retrieve the transaction id from the TransactionId header.
TransactionInfo	getTransactionInfo() Retrieve the 'transactioninfo' request body that must be included with the UNLOCK request of a transaction lock.

Methods inherited from interface org.apache.jackrabbit.webdav.DavServletRequest

getDavSession, getDepth, getDepth, getDestinationLocator, getLockInfo, getLockToken, getPropFindProperties, getPropFindType, getPropPatchChangeList, getRequestDocument, getRequestLocator, getTimeout, isOverwrite, matchesIfHeader, matchesIfHeader, setDavSession

Methods inherited from interface javax.servlet.http.HttpServletRequest

authenticate, changeSessionId, getAuthType, getContextPath, getCookies, getDateHeader, getHeader, getHeaderNames, getHeaders, getIntHeader, getMethod, getPart, getParts, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getRequestURL, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, login, logout, upgrade

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentLengthLong, getContentType, getDispatcherType, getInputStream, getLocalAddr, getLocale, getLocales, getLocalName, getLocalPort, getParameter, getParameterMap, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRemotePort, getRequestDispatcher, getScheme, getServerName, getServerPort, getServletContext, isAsyncStarted, isAsyncSupported, isSecure, removeAttribute, setAttribute, setCharacterEncoding, startAsync, startAsync

Method Detail

getTransactionInfo

TransactionInfo getTransactionInfo()
                            throws DavException

Retrieve the 'transactioninfo' request body that must be included with the UNLOCK request of a transaction lock. If the request body is does not provide the information required (either because it is missing or the Xml is not valid) null is returned.

Returns:

TransactionInfo object encapsulating the 'transactioninfo' Xml element present in the request body or null if no body is present or if it could not be parsed.

Throws:

DavException - if an invalid request body is present.

getTransactionId

String getTransactionId()

Retrieve the transaction id from the TransactionId header.

Returns:

transaction id as present in the TransactionId header or null.