org.apache.jackrabbit.webdav.transaction
Interface TransactionDavServletRequest

All Superinterfaces:
DavServletRequest, HttpServletRequest, 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.


Method Summary
 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
getAuthType, getCookies, getDateHeader, getHeader, getHeaderNames, getIntHeader, getMethod, getPathInfo, getPathTranslated, getQueryString, getRemoteUser, getRequestedSessionId, getRequestURI, getServletPath, getSession, getSession, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid
 
Methods inherited from interface javax.servlet.ServletRequest
getAttribute, getAttributeNames, getCharacterEncoding, getContentLength, getContentType, getInputStream, getParameter, getParameterNames, getParameterValues, getProtocol, getReader, getRealPath, getRemoteAddr, getRemoteHost, getScheme, getServerName, getServerPort, setAttribute
 

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.


Copyright © 2011-2013 Adobe Systems Incorporated. All Rights Reserved.